API RIS
Authentication
API RIS
Endpoints for complete management of clinical flow: authentication, patient registration, rooms, partners, units, physicians, procedures and appointments. All requests use Bearer Token JWT obtained via
/authenticate.Base URL: api.ris.medcloud.co
POST
/authenticate
Authenticate User
Validates the credentials and returns a Bearer JWT token required for all subsequent calls. The token must be sent in the Authorization header as: Bearer <token>.
Body Parameters
| Body Parameter | Type | Description |
| :--- | :--- | :--- |
| username | string (required) | Username. Maximum 100 characters. |
| password | string (required) | User password. Maximum 100 characters. |
| clinicIdToAccess | integer (required) | Numeric ID of the clinic to be accessed. |
Response Codes (200)
| Code | Type | Description |
| :--- | :--- | :--- |
| 200 | JSON (Object) | Authentication successful. Returns the `token` field containing the JWT for use in subsequent requests. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 401 | `INVALID_CREDENTIALS` | Incorrect credentials or invalid clinic. |
| 500 | `INTERNAL_SERVER_ERROR` | Unexpected internal error. |
curl -X POST https://replace.com/authenticate \ -H "Content-Type: application/json" \ -d '{ "username": "john.doe", "password": "securePassword123", "clinicIdToAccess": 42 }'
cURL / JSON
curl -X POST https://replace.com/authenticate \ -H "Content-Type: application/json" \ -d '{ "username": "john.doe", "password": "securePassword123", "clinicIdToAccess": 42 }'{ "token": "eyJhbGciOiJIUzI1NiIsInR5..."
}
Response · 200
{ "token": "eyJhbGciOiJIUzI1NiIsInR5..."
}{ "token": "eyJhbGciOiJIUzI1NiIsInR5..."
}
Response · Error
{ "token": "eyJhbGciOiJIUzI1NiIsInR5..."
}POST
/patient
Create Patient
Path ParametersRegisters a new patient at the clinic. personalIdentification and email must be unique — duplicates return an error. Note: If a patient already exists with the same personalIdentification or email, the API returns DUPLICATED_PATIENT.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT Bearer token. Format: `Bearer `. |
Body Parameters
| Body Parameter | Type | Description |
| :--- | :--- | :--- |
| name | string (required) | Full name. Max. 200 characters. |
| personalIdentification | string (required) | CPF or ID number. Max. 20 characters. Required depending on the clinic's configuration. |
| email | string (required) | Patient’s email address. Email format. Max. 100 characters. |
| birthDate | string (date) (optional) | Date of birth. ISO 8601 format. |
| gender | enum (optional) | `FEMALE` · `MALE` · `NOT_INFORMED` · `OTHER` |
| cellPhone | string (optional) | Cell phone number. Max. 45 characters. |
| socialName | string (optional) | Common name. Max. 200 characters. |
| motherName | string (optional) | Mother’s name. Max. 300 characters. |
| height | number (optional) | Height in centimeters. Default: 0. |
| weight | number (optional) | Weight in kg. Default: 0. |
| observations | string (optional) | Clinical observations. Max. 300 characters. |
| address | object (optional) | Full address. See the `Address` schema. |
Response Codes (Error/Status)
| Códigos de Resposta (Erro/Status) | Tipo | Descrição |
| :--- | :--- | :--- |
| 201 | Created | Paciente criado. Retorna `{ patientId }`. |
| 400 | `VALIDATION_ERROR` | Schema inválido. |
| 401 | `UNAUTHORIZED` | Token ausente ou inválido. |
| 500 | `INTERNAL_SERVER_ERROR` | Erro interno — possível `DUPLICATED_PATIENT` (conflito de CPF/E-mail). |
{ "patient": { "name": "Michael Robert", "personalIdentification": "132333957839", "email": "nomail@gmail.com", "birthDate": "1990-05-15", "gender": "MALE", "cellPhone": "111 9844422" }
}
cURL / JSON
{ "patient": { "name": "Michael Robert", "personalIdentification": "132333957839", "email": "nomail@gmail.com", "birthDate": "1990-05-15", "gender": "MALE", "cellPhone": "111 9844422" }
}
Response · 200
Response · Error
GET
/patient/{id}
Search for a Patient
Returns a patient's complete data based on their unique identifier.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT Bearer token. Format: `Bearer `. |
Response Codes (200)
| Code | Type | Description |
| :--- | :--- | :--- |
| 200 | JSON (Object) | Returns the complete `patient` object. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Patient not found. |
curl https://replace.com/patient/101 \ -H "Authorization: Bearer "
cURL / JSON
curl https://replace.com/patient/101 \ -H "Authorization: Bearer " curl https://replace.com/patient/101 \ -H "Authorization: Bearer "
Response · 200
curl https://replace.com/patient/101 \ -H "Authorization: Bearer "
Response · Error
PUT
/patient/{id}
Update Patient
Updates a patient's data. All fields are optional, but at least one must be submitted. Same uniqueness rules as for the POST request.
Header Parameters
| Parâmetro de Header | Tipo | Descrição |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Formato: `Bearer `. |
Response Codes (Error/Status)
| Códigos de Resposta (Erro/Status) | Tipo | Descrição |
| :--- | :--- | :--- |
| 204 | No Content | Paciente atualizado. Sem corpo de resposta. |
| 400 | `VALIDATION_ERROR` | Schema inválido ou duplicata de e-mail/CPF (`DUPLICATED_PATIENT`). |
| 401 | `UNAUTHORIZED` | Token inválido. |
| 404 | `NOT_FOUND` | Paciente não encontrado. |
| 500 | `INTERNAL_SERVER_ERROR` | Erro interno no servidor. |
{ "patient": { "cellPhone": "111 99999999", "socialName": "Michael" }
}
cURL / JSON
{ "patient": { "cellPhone": "111 99999999", "socialName": "Michael" }
}// 204 No Content — sem corpo
Response · 200
// 204 No Content — sem corpo
Response · Error
POST
/room
Create a Room
Registers a procedure room. The operating period must include full slots of the specified duration. If startTime does not fit within the slot, it returns ROOM_START_TIME_DOES_NOT_FIT_INTO_PROCEDURE_DURATION_SPOT.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT Bearer token. Format: `Bearer `. |
Body Parameters
| Body Parameter | Type | Description |
| :--- | :--- | :--- |
| name | string (required) | Room name. Max. 200 characters. |
| number | integer (required) | Room ID. |
| startTime | string (required) | Start time. Format `HH:MM`. |
| endTime | string (required) | End time. Format `HH:MM`. |
| procedureDuration | integer (required) | Duration in minutes per slot. |
| modality | string (optional) | Modality. Max. 2 characters. Ex.: `“CT”`. |
| status | enum (optional) | `AVAILABLE` · `MAINTENANCE` · `UNAVAILABLE`. Default: AVAILABLE. |
| unitId | integer (optional) | ID of the linked unit. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 201 | Created | Room created. Returns `{ roomId }`. |
| 400 | `VALIDATION_ERROR` | Invalid schema or incompatible time slot (`ROOM_START_TIME_DOES_NOT_FIT_INTO_PROCEDURE_DURATION_SPOT`). |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 500 | `INTERNAL_SERVER_ERROR` | Internal server error. |
{ "room": { "name": "Room 1", "number": 15, "startTime": "08:00", "endTime": "18:00", "procedureDuration": 30, "modality": "CT", "status": "AVAILABLE" }
}
cURL / JSON
{ "room": { "name": "Room 1", "number": 15, "startTime": "08:00", "endTime": "18:00", "procedureDuration": 30, "modality": "CT", "status": "AVAILABLE" }
}{ "roomId": 7 }
Response · 200
{ "roomId": 7 }{ "errorMessage": "VALIDATION_ERROR", "errorType": "VALIDATION_ERROR", "validationsErrors": [{ "message": "startTime does not fit slot", "path": "room.startTime" }]
}
Response · Error
{ "errorMessage": "VALIDATION_ERROR", "errorType": "VALIDATION_ERROR", "validationsErrors": [{ "message": "startTime does not fit slot", "path": "room.startTime" }]
}GET
/room/{id}
Search for a Room
Returns the data for a room by its ID.
curl https://replace.com/room/7 \ -H "Authorization: Bearer "
cURL / JSON
curl https://replace.com/room/7 \ -H "Authorization: Bearer " { "sala": { "nombre": "Sala 1", "número": 15, "horaInicio": "08:00", "horaFin": "18:00", "duraciónDelProcedimiento": 30, "estado": "DISPONIBLE" }
}
Response · 200
{ "sala": { "nombre": "Sala 1", "número": 15, "horaInicio": "08:00", "horaFin": "18:00", "duraciónDelProcedimiento": 30, "estado": "DISPONIBLE" }
}
Response · Error
PUT
/room/{id}
Upate Room
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Format: 'Bearer '. |
Body Parameters
| Body parameter | Type | Description |
| :--- | :--- | :--- |
| name | string (optional) | room name. Max 200 chars. |
| number | integer (optional) | room identification number. |
| startTime | string (optional) | opening. Format `HH:MM` |
| endTime | string (optional) | close. Format `HH:MM` |
| procedureDuration | integer (optional) | Duration in minutes per slot. |
| modality | string (optional) | modality. Max 2 chars. Ex.: `"CT"`|
| status | enum (optional) | `AVAILABLE` MAINTENANCE` UNAVAILABLE. |
| unitId | integer (optional) | linked unit ID. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 204 | No Content | Updated room. No response body. |
| 400 | 'VALIDATION_ERROR' | Invalid schema or mismatch in slot (startTime must fit in duration). |
| 401 | 'UNAUTHORIZED' | Invalid token. |
| 404 | 'NOT_FOUND' | Room not found. |
{ "room": { "status": "MAINTENANCE" }
}
cURL / JSON
{ "room": { "status": "MAINTENANCE" }
}// 204 No Content
Response · 200
// 204 No Content
Response · Error
POST
/partner
Create Partner
Register a partner (insurance, insurance or partner clinic) with their payment rules.
Header Parameters
| Parâmetro de Header | Tipo | Descrição |
| :--- | :--- | :--- |
| Autorização | string (obrigatório) | Bearer Token JWT. Formato: `Bearer `. |
Response Codes (200)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 204 | No Content | Updated room. No body of answer. |
| 400 | `VALIDATION_ERROR` | Invalid schema or incompatibility in the slot (startTime must fit the duration). |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Room not found. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 201 | Created | Partner created. Returns `{ partnerId }`. |
| 400 | `VALIDATION_ERROR` | Invalid schema. |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 500 | `INTERNAL_SERVER_ERROR` | Internal server error. |
201: Partner created. Returns { partnerId }. 400 (VALIDATION_ERROR): Invalid schema. 401 (UNAUTHORIZED): Invalid token. 500 (INTERNAL_SERVER_ERROR): Internal error.
cURL / JSON
201: Partner created. Returns { partnerId }. 400 (VALIDATION_ERROR): Invalid schema. 401 (UNAUTHORIZED): Invalid token. 500 (INTERNAL_SERVER_ERROR): Internal error.// 204 No Content
Response · 200
// 204 No Content
Response · Error
GET
/partner/{id}
Find a Partner
Returns data from a partner by ID.
Header Parameters
| Parâmetro de Header | Tipo | Descrição |
| :--- | :--- | :--- |
| Autorização | string (obrigatório) | Bearer Token JWT. Formato: `Bearer `. |
Response Codes (200)
| Code | Type | Description |
| :--- | :--- | :--- |
| 200 | JSON (Object) | Returns object `partner`. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Partner not found. |
curl https://replace.com/partner/12 \ -H "Authorization: Bearer "
cURL / JSON
curl https://replace.com/partner/12 \ -H "Authorization: Bearer " { "partner": { "name": "Robert Clinic", "paymentType": "COPARTICIPATION", "status": "AVAILABLE" }
}
Response · 200
{ "partner": { "name": "Robert Clinic", "paymentType": "COPARTICIPATION", "status": "AVAILABLE" }
}
Response · Error
PUT
/partner/{id
Upgrade Partner
Header Parameters
| Parâmetro de Header | Tipo | Descrição |
| :--- | :--- | :--- |
| Autorização | string (obrigatório) | Bearer Token JWT. Formato: `Bearer `. |
Body Parameters
| Body parameter | Type | Description |
| :--- | :--- | :--- |
| name | string (optional) | partner name. Max 200 chars. |
| identificationDocument | string (optional) | CNPJ or document. Max 19 chars. |
| paymentType | enum (optional) | `PARTIAL` `TOTAL` `COPARTICIPATION` |
| status | enum (optional) | `AVAILABLE` |
| email | string (optional) | partner email. Max 100 chars. |
| hasBilling | boolean (optional) | indicates whether the partner has invoicing activated. |
| address | object (optional) | Address. See schema `Address`. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 204 | No Content | Updated partner. |
| 400 | `VALIDATION_ERROR` | Invalid schema. |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Partner not found. |
{ "partner": { "status": "UNAVAILABLE" }
}
cURL / JSON
{ "partner": { "status": "UNAVAILABLE" }
}// 204 No Content
Response · 200
// 204 No Content
Response · Error
POST
/unit
Create unity
Register a clinical unit with its identification and address data.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Format: `Bearer `. |
Body Parameters
| Parâmetro de Body | Tipo | Descrição |
| :--- | :--- | :--- |
| name | string (required) | nome da unidade. Máx. 200 chars. |
| identificationDocument | string (required) | CNPJ ou documento. Máx. 20 caracteres. |
| address | object (required) | Endereço completo. Ver esquema `Address`. |
| corporateName | string (opcional) | razão social. Máx. 200 caracteres. |
| cnes | string (opcional) | código CNES. Máx. 10 caracteres. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 201 | Created | Unit created. Returns `{ unitId }`. |
| 400 | `VALIDATION_ERROR` | Invalid schema. |
| 401 | `UNAUTHORIZED` | Invalid token. |
{ "unit": { "name": "Downtown Unit", "identificationDocument": "103958503", "corporateName": "Downtown Unit LTDA", "address": { "zipCode": "97297", "street": "Main Street", "number": "201", "city": "Los Angeles", "state": "California", "country": "Brazil", "district": "Hollywood" } }
}
cURL / JSON
{ "unit": { "name": "Downtown Unit", "identificationDocument": "103958503", "corporateName": "Downtown Unit LTDA", "address": { "zipCode": "97297", "street": "Main Street", "number": "201", "city": "Los Angeles", "state": "California", "country": "Brazil", "district": "Hollywood" } }
}{ "unitId": 3 }
Response · 200
{ "unitId": 3 }
Response · Error
GET
/unit/{id}
Seek Unity
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Format: `Bearer `. |
Response Codes (200)
| Code | Type | Description |
| :--- | :--- | :--- |
| 200 | JSON (Object) | Returns object `unit`. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Unit not found. |
curl https://replace.com/unit/3 \ -H "Authorization: Bearer "
cURL / JSON
curl https://replace.com/unit/3 \ -H "Authorization: Bearer "
Response · 200
Response · Error
PUT
/unit/{id}
Update Unity
Updates data from one unit. All fields are optional.
Header Parameters
| Parâmetro de Header | Tipo | Descrição |
| :--- | :--- | :--- |
| Autorização | string (obrigatório) | Bearer Token JWT. Formato: `Bearer `. |
Body Parameters
| Body parameter | Type | Description |
| :--- | :--- | :--- |
| name | string (optional) | Unit name. Max 200 chars. |
| identificationDocument | string (optional) | CNPJ or document. Max 20 chars. |
| address | object (optional) | full address. See schema `Address`. |
| corporateName | string (optional) | Company name. Maximum 200 characters. |
| cnes | string (optional) | CNES code. Max 10 chars. |
Response Codes (Error/Status)
| Códigos de Resposta (Erro/Status) | Tipo | Descrição |
| :--- | :--- | :--- |
| 204 | No Content | Unidade atualizada. |
| 401 | `UNAUTHORIZED` | Token inválido. |
| 404 | `NOT_FOUND` | Unidade não encontrada. |
{ "unit": { "cnes": "1234567890" }
}
cURL / JSON
{ "unit": { "cnes": "1234567890" }
}// 204 No Content
Response · 200
// 204 No Content
Response · Error
POST
/doctor
Create Doctor
201: Médico criado. Retorna { doctorId }. 400 (VALIDATION_ERROR): Schema inválido. 401 (UNAUTHORIZED): Token inválido. 500 (INTERNAL_SERVER_ERROR): CRM ou e-mail duplicado.
cURL / JSON
201: Médico criado. Retorna { doctorId }. 400 (VALIDATION_ERROR): Schema inválido. 401 (UNAUTHORIZED): Token inválido. 500 (INTERNAL_SERVER_ERROR): CRM ou e-mail duplicado.{ "doctorId": 55 }
Response · 200
{ "doctorId": 55 }
Response · Error
/doctor/{id}
Update Doctor
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Format: `Bearer `. |
Body Parameters
| Body parameter | Type | Description |
| :--- | :--- | :--- |
| name | string (optional) | Full name. Max. 200 chars. |
| medicalIdentification | string (optional) | CRM. Max. 20 chars. |
| personalIdentification | string (optional) | CPF. Max. 20 chars. |
| email | string (optional) | Email. Max 200 chars. |
| status | enum (optional) | `AVAILABLE` |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 204 | No Content | Updated doctor. No body reply. |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Doctor not found. |
{ "doctor": { "status": "UNAVAILABLE" }
}
cURL / JSON
{ "doctor": { "status": "UNAVAILABLE" }
}// 204 No Content
Response · 200
// 204 No Content
Response · Error
POST
/medical-procedure
Create Medical Procedure
Header Parameters
| Header parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT bearer token. Format: `Bearer `. |
Body Parameters
| Parâmetro de Body | Tipo | Descrição |
| :--- | :--- | :--- |
| medicalProcedure.price | number (required) | valor do procedimento. Máx. 99999999999. |
| medicalProcedure.name | string (required) | nome do procedimento. Máx. 200 chars. |
| medicalProcedure.modality | string (required) | Modalidade. Máx. 2 caracteres. Ex.: `"CT"`. |
| medicalProcedure.instructions | string (optional) | instruções ao paciente. Máx. 500 chars. |
| linkedPartnerIds | integer[] (opcional) | array de IDs de parceiros vinculados. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 201 | Created | Returns `{ medicalProcedureId }`. |
| 400 | `VALIDATION_ERROR` | Invalid schema. |
| 401 | `UNAUTHORIZED` | Invalid token. |
{ "medicalProcedure": { "price": 255.55, "name": "Lasik Surgery", "modality": "CT", "instructions": "Evitar lentes de contato 5 dias antes" }, "linkedPartnerIds": [12, 15]
}
cURL / JSON
{ "medicalProcedure": { "price": 255.55, "name": "Lasik Surgery", "modality": "CT", "instructions": "Evitar lentes de contato 5 dias antes" }, "linkedPartnerIds": [12, 15]
}{ "medicalProcedureId": 3 }
Response · 200
{ "medicalProcedureId": 3 }
Response · Error
GET
/medical-procedure/{id}
Seek Medical Procedure
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Format: `Bearer `. |
Response Codes (200)
| Code | Type | Description |
| :--- | :--- | :--- |
| 200 | JSON (Object) | Returns structured object with `medicalProcedure` + `linkedPartnerIds`. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Procedure not found. |
cURL / JSON
{ "medicalProcedure": { "price": 255.55, "name": "Lasik Surgery", "modality": "CT" }, "linkedPartnerIds": [12, 15]
}
Response · 200
{ "medicalProcedure": { "price": 255.55, "name": "Lasik Surgery", "modality": "CT" }, "linkedPartnerIds": [12, 15]
}
Response · Error
PUT
/medical-procedure/{id}
Update Medical Procedure
Updates data from a procedure and/or its linked partners.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Format: `Bearer `. |
Body Parameters
| Body parameter | Type | Description |
| :--- | :--- | :--- |
| medicalProcedure.price | number (optional) | Procedure value. |
| medicalProcedure.name | string (optional) | Procedure name. |
| medicalProcedure.modality | string (optional) | Examination mode. |
| medicalProcedure.instructions | string (optional) | patient instructions. |
| linkedPartnerIds | integer[] (optional) | Array of linked partner IDs. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 204 | No Content | Updated procedure. |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 404 | `NOT_FOUND` | Procedure not found. |
Novo Site @ Medcloud Share
Atualizar Procedimento Médico
atualizar-procedimento-medico
www.medcloud.link/endpoints/
atualizar-procedimento-medico
/medical-procedure/{id}
Atualiza dados de um procedimento e/ou seus parceiros vinculados.
id (integer, path, required): ID do procedimento.
204: Procedimento atualizado.
401 (UNAUTHORIZED): Token inválido.
404 (NOT_FOUND): Procedimento não encontrado.
{ "medicalProcedure": { "price": 299.90 }, "linkedPartnerIds": [12]
}
// 204 No Content
| Parâmetro de Header | Tipo | Descrição |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Formato: `Bearer `. |
| Parâmetro de Path | Tipo | Descrição |
| :--- | :--- | :--- |
| id | integer (required) | ID único do procedimento a atualizar. |
| Parâmetro de Body | Tipo | Descrição |
| :--- | :--- | :--- |
| medicalProcedure.price | number (optional) | Valor do procedimento. |
| medicalProcedure.name | string (optional) | Nome do procedimento. |
| medicalProcedure.modality | string (optional) | Modalidade de exame. |
| medicalProcedure.instructions | string (optional) | Instruções ao paciente. |
| linkedPartnerIds | integer[] (optional) | Array de IDs de parceiros vinculados. |
| Códigos de Resposta (Erro/Status) | Tipo | Descrição |
| :--- | :--- | :--- |
| 204 | No Content | Procedimento atualizado. |
| 401 | `UNAUTHORIZED` | Token inválido. |
| 404 | `NOT_FOUND` | Procedimento não encontrado. |
AtualizarProcedimentoMedico 6a3beee091d88e82a365ee9b
cURL / JSON
Novo Site @ Medcloud Share
Atualizar Procedimento Médico
atualizar-procedimento-medico
www.medcloud.link/endpoints/
atualizar-procedimento-medico
/medical-procedure/{id}
Atualiza dados de um procedimento e/ou seus parceiros vinculados.
id (integer, path, required): ID do procedimento.
204: Procedimento atualizado.
401 (UNAUTHORIZED): Token inválido.
404 (NOT_FOUND): Procedimento não encontrado.
{ "medicalProcedure": { "price": 299.90 }, "linkedPartnerIds": [12]
}
// 204 No Content
| Parâmetro de Header | Tipo | Descrição |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Formato: `Bearer `. |
| Parâmetro de Path | Tipo | Descrição |
| :--- | :--- | :--- |
| id | integer (required) | ID único do procedimento a atualizar. |
| Parâmetro de Body | Tipo | Descrição |
| :--- | :--- | :--- |
| medicalProcedure.price | number (optional) | Valor do procedimento. |
| medicalProcedure.name | string (optional) | Nome do procedimento. |
| medicalProcedure.modality | string (optional) | Modalidade de exame. |
| medicalProcedure.instructions | string (optional) | Instruções ao paciente. |
| linkedPartnerIds | integer[] (optional) | Array de IDs de parceiros vinculados. |
| Códigos de Resposta (Erro/Status) | Tipo | Descrição |
| :--- | :--- | :--- |
| 204 | No Content | Procedimento atualizado. |
| 401 | `UNAUTHORIZED` | Token inválido. |
| 404 | `NOT_FOUND` | Procedimento não encontrado. |
AtualizarProcedimentoMedico 6a3beee091d88e82a365ee9b
Response · 200
Response · Error
POST
/schedule
Create Schedule
Schedule a medical procedure for a patient in a room. Accept payment information from the patient and partner’s co-participation. If the partner has paymentType "PARTIAL" or "TOTAL" and the body includes patientPayment, then coparticipationPayment is required.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | Bearer Token JWT. Format: `Bearer `. |
Body Parameters
| Parâmetro de Body | Tipo | Descrição |
| :--- | :--- | :--- |
| schedule.date | string (data) (obrigatório) | data do agendamento. ISO 8601. |
| schedule.startTime | string (time) (required) | hora de início. `HH:MM` |
| schedule.medicalProcedureId | inteiro (obrigatório) | ID do procedimento médico. |
| schedule.patientId | inteiro (opcional) | ID do paciente. |
| schedule.roomId | inteiro (opcional) | ID da sala. |
| schedule.partnerId | inteiro (opcional) | ID do parceiro. |
| schedule.priority | integer (optional) | Nível de prioridade do agendamento. |
| patientPayment | object (optional) | Objeto de pagamento com `status` (`PAID`/`NOT_PAID`), `value` e `method` (`PIX`/`CASH`/`CREDIT`/etc). |
| coparticipationPayment | object (conditional) | Obrigatório se o parceiro para PARTIAL/TOTAL + patientPayment presente. `{ value: number }`. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 201 | Created | Schedule created. Returns `{ scheduleId }`. |
| 400 | `VALIDATION_ERROR` | Invalid scheme or co-participation rule violated. |
| 401 | `UNAUTHORIZED` | Invalid token. |
| 500 | `INTERNAL_SERVER_ERROR` | Internal error. |
{ "schedule": { "date": "2026-07-10", "startTime": "09:00", "medicalProcedureId": 3, "patientId": 101, "roomId": 7, "partnerId": 12 }, "patientPayment": { "status": "PAID", "value": 255.55, "method": "PIX" }
}
cURL / JSON
{ "schedule": { "date": "2026-07-10", "startTime": "09:00", "medicalProcedureId": 3, "patientId": 101, "roomId": 7, "partnerId": 12 }, "patientPayment": { "status": "PAID", "value": 255.55, "method": "PIX" }
}{ "scheduleId": 528 }
Response · 200
{ "scheduleId": 528 }{ "errorMessage": "VALIDATION_ERROR", "errorType": "VALIDATION_ERROR", "validationsErrors": [{ "message": "coparticipationPayment required", "path": "coparticipationPayment" }]
}
Response · Error
{ "errorMessage": "VALIDATION_ERROR", "errorType": "VALIDATION_ERROR", "validationsErrors": [{ "message": "coparticipationPayment required", "path": "coparticipationPayment" }]
}GET
/schedule/{id}
Search Scheduling
Returns complete data for an agreement, including status and payment status.Amounts accepted at schedule.status:CANCELED · COMPLETED · CONFIRMED · ONLINE_CANCELED · ONLINE_CONFIRMED · ONLINE_SCHEDULED · IN_PROGRESS · NOT_CONFIRMED · WAITING_FOR_BILLING · WAITING_FOR_CHECKOUT · WITHDRAW_ · DELETED.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT bearer token. Format: 'Operator'. |
Path Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT bearer token. Format: 'Operator'. |
Response Codes (200)
| Status | errorType | Description |
| :--- | :--- | :--- |
| 200 | — | Returns the complete schedule object. |
| 401 | UNAUTHORIZED | Token invaded. |
| 404 | NOT_FOUND | Schedule not found. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 401 | 'UNAUTHORIZED' | Token invaded. |
| 404 | 'NOT_FOUND' | Schedule not found. |
cURL / JSON
{ "schedule": { "date": "2026-07-10", "startTime": "09:00", "medicalProcedureId": 3, "patientId": 101, "status": "CONFIRMED", "paymentStatus": "PAID" }
}
Response · 200
{ "schedule": { "date": "2026-07-10", "startTime": "09:00", "medicalProcedureId": 3, "patientId": 101, "status": "CONFIRMED", "paymentStatus": "PAID" }
}
Response · Error
PUT
/schedule/{id}
Update Scheduling
Updates data from a schedule. Appointments with confirmed payment (paymentStatus: PAID) cannot be changed. Same co-participation rule as POST applies.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT Bearer Token. Format: 'Carrier'. |
Body Parameters
| Body Parameter | Type | Description |
| :--- | :--- | :--- |
| schedule.date | string (date) (optional) | Schedule date. |
| schedule.startTime | string (time) (optional) | Start time. |
| schedule.medicalProcedureId | integer (optional) | Medical procedure ID. |
| schedule.patientId | integer (optional) | patient ID. |
| schedule.roomId | integer (optional) | Room ID. |
| schedule.partnerId | integer (optional) | Partner ID. |
| schedule.priority | integer (optional) | Schedule priority level. |
| patientPayment | object (optional) | Updatable internal payment data. |
| coparticipationPayment | object (conditional) | Follows validations equivalent to those in the POST. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 204 | No Content | Scheduling updated successfully. |
| 400 | 'VALIDATION_ERROR' | Invalid schema or attempt to change schedule with confirmed payment ('paymentStatus: PAID'). |
| 401 | 'UNAUTHORIZED' | Invalid token. |
| 404 | 'NOT_FOUND' | Scheduling not found. |
cURL / JSON
Response · 200
Response · Error
GET
/doctor/{id}
Search Doctor
Returns data from a doctor by ID.
Header Parameters
| Header Parameter | Type | Description |
| :--- | :--- | :--- |
| Authorization | string (required) | JWT Bearer Token. Format: 'Carrier'. |
Response Codes (200)
| Code | Type | Description |
| :--- | :--- | :--- |
| 200 | JSON (Object) | Returns 'doctor' object. |
Response Codes (Error/Status)
| Response Codes (Error/Status) | Type | Description |
| :--- | :--- | :--- |
| 401 | 'UNAUTHORIZED' | Invalid token. |
| 404 | 'NOT_FOUND' | Doctor not found. |
cURL / JSON
Response · 200
Response · Error