Powered by Redocly

Patient

Rota responsável por retornar uma lista de todos os clientes cadastrados no sistema

SecurityoAuth2ClientCredentials
Request
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
clinicId
integer or null <int32>
statusId
integer or null <int32>
solicitationTypeId
integer or null <int32>
month
integer or null <int32>
dateStart
string or null <date-time>
dateEnd
string or null <date-time>
name
string or null
cpf
string or null
Responses
200

A list of all patients registered in the system

400

Unable to return a list of all patients due to validation error

404

No patients registered in the system was found

get/api/v1/patients
Response samples
application/json
[
  • {
    }
]

Rota responsável pelo registo dos dados do paciente

SecurityoAuth2ClientCredentials
Request
Request Body schema:
email
required
string <email>
name
required
string
cpf
required
string
birthdate
required
string
phoneNumber
required
string
isSmartPhone
required
boolean
Responses
200

Retorne um novo usuário com o perfil do paciente

400

Não é possível retornar um novo usuário com o perfil do paciente devido a um erro de validação

post/api/v1/patients
Request samples
{
  • "email": "fernando@email.com",
  • "name": "Fernando Oliveira de Rocha",
  • "cpf": "123.456.789.01",
  • "birthdate": "22/12/1995",
  • "phoneNumber": "(61) 93847-2847",
  • "isSmartPhone": false
}
Response samples
application/json
{
  • "userId": "string"
}

Rota responsável por devolver uma lista de clientes cadastrados no sistema por uma clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
clinicId
integer or null <int32>
statusId
integer or null <int32>
solicitationTypeId
integer or null <int32>
month
integer or null <int32>
Responses
200

A list of all patients registered by a clinic in the system

400

Unable to return a list of all patients registered by a clinic due to validation error

404

No patients registered by this clinic id in the system was found

get/api/v1/clinics/{clinicId}/patients
Response samples
application/json
[
  • {
    }
]

Rota responsável por devolver todos os dados relacionados a um cliente

SecurityoAuth2ClientCredentials
Request
path Parameters
patientId
required
string or null
Responses
200

Return a patient registered in the system

400

Unable to return a patient due to validation error

404

No patient registered with this id in the system was found

get/api/v1/patients/{patientId}
Response samples
application/json
{
  • "id": "12345bc5-cbad-49af-8095-c6b123e1234w",
  • "name": "Paulo Gonçalves Ferreira ",
  • "cpf": "123.456.789-01",
  • "userName": "paulo@email.com",
  • "email": "paulo@email.com",
  • "phoneNumber": "(61) 98374-2827",
  • "isSmartPhone": true,
  • "birthdate": "22/12/1995",
  • "createdAt": "2022-08-18T15:06:43.4915617+00:00",
  • "address": {
    },
  • "bankData": {
    },
  • "personalData": {
    },
  • "occupationData": {
    },
  • "solicitations": [ ],
  • "documents": [ ],
  • "userRoles": [ ]
}

Rota responsável pela atualização do registo dos dados do paciente

SecurityoAuth2ClientCredentials
Request
path Parameters
patientId
required
integer <int32>
Request Body schema:
email
required
string <email>
name
required
string
cpf
required
string
birthdate
required
string
phoneNumber
required
string
isSmartPhone
required
boolean
Responses
200

Retorne os dados do paciente atualizado

400

Não é possível retornar atualizar os dados do perfil do paciente devido a um erro de validação

put/api/v1/patients/{patientId}
Request samples
{
  • "email": "fernando@email.com",
  • "name": "Fernando Oliveira de Rocha",
  • "cpf": "123.456.789.01",
  • "birthdate": "22/12/1995",
  • "phoneNumber": "(61) 93847-2847",
  • "isSmartPhone": false
}
Response samples
application/json
{
  • "userId": "string"
}

Rota responsável por devolver todos os dados relativos a um cliente, mas apenas com a solicitação que a clínica possa ver

SecurityoAuth2ClientCredentials
Request
path Parameters
patientId
required
string or null
clinicId
required
string or null
Responses
200

Return a patient registered in the system

400

Unable to return a patient due to validation error

404

No patient registered with this id in the system was found

get/api/v1/clinics/{clinicId}/patients/{patientId}
Response samples
application/json
{
  • "id": "12345bc5-cbad-49af-8095-c6b123e1234w",
  • "name": "Paulo Gonçalves Ferreira ",
  • "cpf": "123.456.789-01",
  • "userName": "paulo@email.com",
  • "email": "paulo@email.com",
  • "phoneNumber": "(61) 98374-2827",
  • "isSmartPhone": true,
  • "birthdate": "22/12/1995",
  • "createdAt": "2022-08-18T15:06:43.4930398+00:00",
  • "address": {
    },
  • "bankData": {
    },
  • "personalData": {
    },
  • "occupationData": {
    },
  • "solicitations": [ ],
  • "documents": [ ],
  • "userRoles": [ ]
}

Rota responsável por retornos de pacientes por CPF

SecurityoAuth2ClientCredentials
Request
path Parameters
cpf
required
string or null
Responses
200

Success

400

Bad Request

404

Not Found

get/api/v1/patients/by-cpf/{cpf}
Response samples
application/json
{
  • "id": "12345bc5-cbad-49af-8095-c6b123e1234w",
  • "name": "Paulo Gonçalves Ferreira ",
  • "cpf": "123.456.789-01",
  • "userName": "paulo@email.com",
  • "email": "paulo@email.com",
  • "phoneNumber": "(61) 98374-2827",
  • "isSmartPhone": true,
  • "birthdate": "22/12/1995",
  • "createdAt": "2022-08-18T15:06:43.4942651+00:00",
  • "address": {
    },
  • "bankData": {
    },
  • "personalData": {
    },
  • "occupationData": {
    },
  • "solicitations": [ ],
  • "documents": [ ],
  • "userRoles": [ ]
}
➔ Next to PersonalData