ProDoctor Cloud - API Aberta

https://open-api.prodoctor.net/api-docs/
Admin
The ProDoctor Cloud Open API is a solution developed to enhance the platform's connectivity and...
Tokens:118,976
Snippets:361
Trust Score:9.3
Update:4 months ago
Show doc for...
Tokens:
Raw
### Request Body Sample for Exporting OPME Guides

Source: https://open-api.prodoctor.net/api-docs/index.html

This sample demonstrates the structure of the request body for filtering and exporting OPME guides. It includes parameters for pagination, date periods, and lists of medical plans and ProDoctor locations.

```json
{
  "pagina": 1,
  "periodo": {
    "dataInicial": "string",
    "dataFinal": "string"
  },
  "convenios": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ],
  "locaisProDoctor": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ]
}
```

--------------------------------

### Successful Response Sample (200 OK) for Exporting OPME Guides

Source: https://open-api.prodoctor.net/api-docs/index.html

This sample shows the structure of a successful response when exporting OPME guides. It includes a payload with exported records and a message object for API feedback.

```json
{
  "payload": {
    "exportacao": {
      "registros": [
        {
          "codigoLocalProDoctor": "string",
          "localProDoctor": "string",
          "prontuario": "string",
          "paciente": "string",
          "convenio": "string",
          "dataSolicitacao": "string",
          "dataAutorizacao": "string",
          "senha": "string",
          "codigoItem": "string",
          "descricaoItem": "string",
          "linhaProcedimento": "string",
          "quantidadeSolicitada": "string",
          "valorUnitarioSolicitado": "string",
          "quantidadeAutorizada": "string",
          "valorUnitarioAutorizado": "string",
          "guia": "string",
          "numeroGuiaOperadora": "string",
          "profissionalSolicitante": "string",
          "tipoGuiaReferenciada": "string",
          "numeroGuiaReferenciada": "string"
        }
      ],
      "quantidade": 0
    }
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### POST /api/v1/Exportacoes/GuiasSolicitadasProrrogacaoInternacao

Source: https://open-api.prodoctor.net/api-docs/index.html

Exports guides for requested hospitalization extensions. This endpoint is designed to retrieve only guides of the type 'Guia de Solicitação de Prorrogação de Internação ou Complementação do Tratamento'. Access requires 'Acessar Faturamento' permission.

```APIDOC
## POST /api/v1/Exportacoes/GuiasSolicitadasProrrogacaoInternacao

### Description
Exports guides for requested hospitalization extensions. This endpoint is designed to retrieve only guides of the type 'Guia de Solicitação de Prorrogação de Internação ou Complementação do Tratamento'. Access requires 'Acessar Faturamento' permission.

### Method
POST

### Endpoint
https://open-api.prodoctor.net/api/v1/Exportacoes/GuiasSolicitadasProrrogacaoInternacao

### Parameters
#### Request Body
- **pagina** (integer) - Optional - Number of the page to export. Defaults to 1.
- **periodo** (object or null) - Optional - Period for searching patient account data.
  - **dataInicial** (string) - Required if periodo is provided - The start date for the search.
  - **dataFinal** (string) - Required if periodo is provided - The end date for the search.
- **convenios** (Array of objects or null) - Optional - List of medical insurance providers for filtering.
  - **estadoItemAlteracao** (integer) - Optional
  - **codigo** (integer) - Optional
  - **suprimirBase64** (boolean) - Optional
  - **suprimirAlertaLimiteRepeticao** (boolean) - Optional
- **locaisProDoctor** (Array of objects or null) - Optional - List of ProDoctor locations for filtering.
  - **estadoItemAlteracao** (integer) - Optional
  - **codigo** (integer) - Optional
  - **suprimirBase64** (boolean) - Optional
  - **suprimirAlertaLimiteRepeticao** (boolean) - Optional

### Request Example
```json
{
  "pagina": 1,
  "periodo": {
    "dataInicial": "string",
    "dataFinal": "string"
  },
  "convenios": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ],
  "locaisProDoctor": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ]
}
```

### Response
#### Success Response (200)
- **payload** (object or null) - Payload containing the export of hospitalization request guides.
  - **exportacao** (object) - Contains the exported records and their count.
    - **registros** (Array of objects) - List of exported guide records.
      - **codigoLocalProDoctor** (string)
      - **localProDoctor** (string)
      - **prontuario** (string)
      - **paciente** (string)
      - **convenio** (string)
      - **conta** (string)
      - **dataSolicitacao** (string)
      - **dataAutorizacao** (string)
      - **senha** (string)
      - **codigoProcedimento** (string)
      - **descricaoProcedimento** (string)
      - **linhaProcedimento** (string)
      - **quantidadeSolicitada** (string)
      - **quantidadeAutorizada** (string)
      - **guia** (string)
      - **numeroGuiaOperadora** (string)
      - **contratadoSolicitante** (string)
      - **guiaSolicitacaoInternacao** (string)
      - **anexoOPME** (string)
      - **anexoQuimioterapia** (string)
      - **anexoRadioterapia** (string)
      - **profissionalSolicitante** (string)
    - **quantidade** (integer)
  - **message** (object or null) - Message from the API, if any validation is needed.
    - **model** (Array of objects)
      - **model** (string)
      - **field** (string)
      - **errors** (Array of strings)
    - **system** (object)
      - **title** (string)
      - **message** (string)
      - **messageType** (integer)
    - **suprimirAlerta** (Array of objects)
      - **titulo** (string)
      - **mensagem** (string)
      - **tipo** (integer)

#### Error Response (400)
- **payload** (any or null) - Payload will be empty on error.
- **message** (object or null) - Message from the API, if any validation is needed.

#### Error Response (401)
- Authentication data invalid.
```

--------------------------------

### POST /api/v1/Exportacoes/GuiasSolicitadasOPME

Source: https://open-api.prodoctor.net/api-docs/index.html

Exports requested OPME guides for patients from ProDoctor Cloud. This route specifically exports guides of type 'Anexo de Solicitação de Órteses, Próteses e Materiais Especiais - OPME'. Access requires 'Acessar Faturamento' permission.

```APIDOC
## POST /api/v1/Exportacoes/GuiasSolicitadasOPME

### Description
Exports requested OPME guides for patients from ProDoctor Cloud. This route specifically exports guides of type 'Anexo de Solicitação de Órteses, Próteses e Materiais Especiais - OPME'. Access requires 'Acessar Faturamento' permission.

### Method
POST

### Endpoint
https://open-api.prodoctor.net/api/v1/Exportacoes/GuiasSolicitadasOPME

### Parameters
#### Request Body
- **pagina** (integer) - Optional - Number of the page to export. Defaults to 1.
- **periodo** (object or null) - Optional - Period for searching by patient account date.
  - **dataInicial** (string) - Required if periodo is provided.
  - **dataFinal** (string) - Required if periodo is provided.
- **convenios** (Array of objects or null) - Optional - List of health plans for the filter.
  - **codigo** (integer) - Required.
- **locaisProDoctor** (Array of objects or null) - Optional - List of ProDoctor Locations for the filter.
  - **codigo** (integer) - Required.

### Request Example
```json
{
  "pagina": 1,
  "periodo": {
    "dataInicial": "string",
    "dataFinal": "string"
  },
  "convenios": [
    {
      "codigo": 0
    }
  ],
  "locaisProDoctor": [
    {
      "codigo": 0
    }
  ]
}
```

### Response
#### Success Response (200)
- **payload** (object or null) - Payload containing the export of OPME request guides.
  - **exportacao** (object)
    - **registros** (Array of objects) - List of exported guide records.
      - **codigoLocalProDoctor** (string)
      - **localProDoctor** (string)
      - **prontuario** (string)
      - **paciente** (string)
      - **convenio** (string)
      - **dataSolicitacao** (string)
      - **dataAutorizacao** (string)
      - **senha** (string)
      - **codigoItem** (string)
      - **descricaoItem** (string)
      - **linhaProcedimento** (string)
      - **quantidadeSolicitada** (string)
      - **valorUnitarioSolicitado** (string)
      - **quantidadeAutorizada** (string)
      - **valorUnitarioAutorizado** (string)
      - **guia** (string)
      - **numeroGuiaOperadora** (string)
      - **profissionalSolicitante** (string)
      - **tipoGuiaReferenciada** (string)
      - **numeroGuiaReferenciada** (string)
    - **quantidade** (integer)
- **message** (object or null) - Message from the API, if any validation is needed.

#### Error Response (400)
- **payload** (any or null) - Payload will be empty on error.
- **message** (object or null) - Message from the API, if any validation is needed.

#### Error Response (401)
- Authentication data invalid.
```

--------------------------------

### POST /api/v1/Exportacoes/GuiasSolicitadasQuimioterapia

Source: https://open-api.prodoctor.net/api-docs/index.html

Exports chemotherapy request guides for patients from ProDoctor Cloud. This route only exports guides of the type 'Anexo de Solicitação de Quimioterapia'. Access requires 'Acessar Faturamento' permission.

```APIDOC
## POST /api/v1/Exportacoes/GuiasSolicitadasQuimioterapia

### Description
Exports chemotherapy request guides for patients from ProDoctor Cloud. This route only exports guides of the type 'Anexo de Solicitação de Quimioterapia'. Access requires 'Acessar Faturamento' permission.

### Method
POST

### Endpoint
https://open-api.prodoctor.net/api/v1/Exportacoes/GuiasSolicitadasQuimioterapia

### Parameters
#### Request Body
- **pagina** (integer) - Optional - Number of the page to export. Defaults to 1.
- **periodo** (object or null) - Optional - Period for searching by patient account date.
  - **dataInicial** (string) - Optional - Initial date of the period.
  - **dataFinal** (string) - Optional - Final date of the period.
- **convenios** (Array of objects or null) - Optional - List of health plans for the filter.
  - **estadoItemAlteracao** (integer) - Optional - Item alteration status.
  - **codigo** (integer) - Optional - Health plan code.
  - **suprimirBase64** (boolean) - Optional - Whether to suppress Base64.
  - **suprimirAlertaLimiteRepeticao** (boolean) - Optional - Whether to suppress repetition limit alert.
- **locaisProDoctor** (Array of objects or null) - Optional - List of ProDoctor locations for the filter.
  - **estadoItemAlteracao** (integer) - Optional - Item alteration status.
  - **codigo** (integer) - Optional - ProDoctor location code.
  - **suprimirBase64** (boolean) - Optional - Whether to suppress Base64.
  - **suprimirAlertaLimiteRepeticao** (boolean) - Optional - Whether to suppress repetition limit alert.

### Request Example
```json
{
  "pagina": 1,
  "periodo": {
    "dataInicial": "string",
    "dataFinal": "string"
  },
  "convenios": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ],
  "locaisProDoctor": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ]
}
```

### Response
#### Success Response (200)
- **payload** (object or null) - Payload containing the export of chemotherapy request guides.
  - **exportacao** (object or null) - Export data.
    - **registros** (Array of objects or null) - List of registered guides.
      - **codigoLocalProDoctor** (string) - ProDoctor location code.
      - **localProDoctor** (string) - ProDoctor location name.
      - **prontuario** (string) - Patient's medical record number.
      - **paciente** (string) - Patient's name.
      - **convenio** (string) - Health plan name.
      - **dataSolicitacao** (string) - Request date.
      - **dataAutorizacao** (string) - Authorization date.
      - **senha** (string) - Access code/password.
      - **codigoItem** (string) - Item code.
      - **descricaoItem** (string) - Item description.
      - **linhaProcedimento** (string) - Procedure line.
      - **guia** (string) - Guide number.
      - **numeroGuiaOperadora** (string) - Operator's guide number.
      - **profissionalSolicitante** (string) - Requesting professional's name.
      - **tipoGuiaReferenciada** (string) - Type of referenced guide.
      - **numeroGuiaReferenciada** (string) - Number of the referenced guide.
    - **quantidade** (integer) - Number of records.
  - **message** (object or null) - Message from the API, if any validation is needed.
    - **model** (Array of objects or null) - Model validation errors.
      - **model** (string) - Model name.
      - **field** (string) - Field name.
      - **errors** (Array of strings) - List of errors.
    - **system** (object) - System error details.
      - **title** (string) - Error title.
      - **message** (string) - Error message.
      - **messageType** (integer) - Type of message.
    - **suprimirAlerta** (Array of objects) - Suppressed alerts.
      - **titulo** (string) - Alert title.
      - **mensagem** (string) - Alert message.
      - **tipo** (integer) - Alert type.

#### Error Response (400)
- **payload** (any or null) - Payload will be empty on error.
- **message** (object or null) - Message from the API, if any validation is needed.

#### Error Response (401)
- Unauthorized
```

--------------------------------

### POST /api/v1/Exportacoes/GuiasSolicitadasSPSADT

Source: https://open-api.prodoctor.net/api-docs/index.html

Exports requested SP/SADT guides for patients. This route only exports guides of the type 'Guia de Solicitação de Serviço Profissional/Serviço Auxiliar de Diagnóstico e Terapia - SP/SADT'. Access requires 'Acessar Faturamento' permission.

```APIDOC
## POST /api/v1/Exportacoes/GuiasSolicitadasSPSADT

### Description
Exports requested SP/SADT guides for patients. This route only exports guides of the type 'Guia de Solicitação de Serviço Profissional/Serviço Auxiliar de Diagnóstico e Terapia - SP/SADT'. Access requires 'Acessar Faturamento' permission.

### Method
POST

### Endpoint
https://open-api.prodoctor.net/api/v1/Exportacoes/GuiasSolicitadasSPSADT

### Parameters
#### Request Body
- **pagina** (integer) - Optional - Number of the page to export. Defaults to 1.
- **periodo** (object or null) - Optional - Period for filtering by patient account date.
  - **dataInicial** (string) - Required if periodo is provided - Initial date of the period.
  - **dataFinal** (string) - Required if periodo is provided - Final date of the period.
- **convenios** (Array of objects or null) - Optional - List of insurance providers for filtering.
  - **codigo** (integer) - Required - Code of the insurance provider.
- **locaisProDoctor** (Array of objects or null) - Optional - List of ProDoctor locations for filtering.
  - **codigo** (integer) - Required - Code of the ProDoctor location.

### Request Example
```json
{
  "pagina": 1,
  "periodo": {
    "dataInicial": "string",
    "dataFinal": "string"
  },
  "convenios": [
    {
      "codigo": 0
    }
  ],
  "locaisProDoctor": [
    {
      "codigo": 0
    }
  ]
}
```

### Response
#### Success Response (200)
- **payload** (object or null) - Payload containing the SP/SADT guide export.
  - **exportacao** (object or null)
    - **registros** (Array of objects) - List of exported guide records.
      - **codigoLocalProDoctor** (string)
      - **localProDoctor** (string)
      - **prontuario** (string)
      - **paciente** (string)
      - **convenio** (string)
      - **conta** (string)
      - **dataHoraSolicitacao** (string)
      - **dataAutorizacao** (string)
      - **senha** (string)
      - **validadeSenha** (string)
      - **codigoProcedimento** (string)
      - **descricaoProcedimento** (string)
      - **linhaProcedimento** (string)
      - **quantidadeSolicitada** (string)
      - **quantidadeAutorizada** (string)
      - **guia** (string)
      - **guiaPrincipal** (string)
      - **numeroGuiaOperadora** (string)
      - **contratadoSolicitante** (string)
      - **anexoOPME** (string)
      - **anexoQuimioterapia** (string)
      - **anexoRadioterapia** (string)
      - **profissionalSolicitante** (string)
    - **quantidade** (integer)
- **message** (object or null) - Message from the API, if any validation is needed.

#### Error Response (400)
- **payload** (any or null) - Payload will be empty on error.
- **message** (object or null) - Message from the API, if any validation is needed.

#### Error Response (401)
- Invalid authentication data.
```

--------------------------------

### POST /api/v1/Exportacoes/GuiasSolicitadasInternacao

Source: https://open-api.prodoctor.net/api-docs/index.html

Exports hospitalization request guides for patients. This route only exports guides of the type 'Guia de Solicitação de Internação'. Access requires the 'Acessar Faturamento' permission.

```APIDOC
## POST /api/v1/Exportacoes/GuiasSolicitadasInternacao

### Description
This endpoint exports hospitalization request guides for patients. It specifically filters for guides of the type 'Guia de Solicitação de Internação'. To use this route, the API key must have the 'Acessar Faturamento' permission.

### Method
POST

### Endpoint
https://open-api.prodoctor.net/api/v1/Exportacoes/GuiasSolicitadasInternacao

### Parameters
#### Request Body
- **pagina** (integer) - Optional - The page number to export. Defaults to 1 if not provided.
- **periodo** (object or null) - Optional - The period for filtering by account date.
  - **dataInicial** (string) - Required if periodo is provided - The initial date for the period.
  - **dataFinal** (string) - Required if periodo is provided - The final date for the period.
- **convenios** (Array of objects or null) - Optional - A list of agreements for filtering.
  - **estadoItemAlteracao** (integer) - Optional - State of item alteration.
  - **codigo** (integer) - Optional - Code of the agreement.
  - **suprimirBase64** (boolean) - Optional - Whether to suppress Base64.
  - **suprimirAlertaLimiteRepeticao** (boolean) - Optional - Whether to suppress repetition limit alerts.
- **locaisProDoctor** (Array of objects or null) - Optional - A list of ProDoctor locations for filtering.
  - **estadoItemAlteracao** (integer) - Optional - State of item alteration.
  - **codigo** (integer) - Optional - Code of the ProDoctor location.
  - **suprimirBase64** (boolean) - Optional - Whether to suppress Base64.
  - **suprimirAlertaLimiteRepeticao** (boolean) - Optional - Whether to suppress repetition limit alerts.

### Request Example
```json
{
  "pagina": 1,
  "periodo": {
    "dataInicial": "string",
    "dataFinal": "string"
  },
  "convenios": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ],
  "locaisProDoctor": [
    {
      "estadoItemAlteracao": 0,
      "codigo": 0,
      "suprimirBase64": true,
      "suprimirAlertaLimiteRepeticao": true
    }
  ]
}
```

### Response
#### Success Response (200)
- **payload** (object or null) - Payload containing the export of hospitalization request guides.
  - **exportacao** (object or null)
    - **registros** (Array of objects or null) - List of exported guides.
      - **codigoLocalProDoctor** (string) - Code of the ProDoctor location.
      - **localProDoctor** (string) - Name of the ProDoctor location.
      - **prontuario** (string) - Patient's medical record number.
      - **paciente** (string) - Patient's name.
      - **convenio** (string) - Agreement name.
      - **conta** (string) - Account number.
      - **dataSolicitacao** (string) - Date of request.
      - **dataAutorizacao** (string) - Date of authorization.
      - **senha** (string) - Authorization code/password.
      - **validadeSenha** (string) - Expiration date of the authorization code.
      - **codigoProcedimento** (string) - Procedure code.
      - **descricaoProcedimento** (string) - Procedure description.
      - **linhaProcedimento** (string) - Procedure line.
      - **quantidadeSolicitada** (string) - Quantity requested.
      - **quantidadeAutorizada** (string) - Quantity authorized.
      - **guia** (string) - Guide number.
      - **numeroGuiaOperadora** (string) - Operator's guide number.
      - **contratadoSolicitante** (string) - Contracting party requesting.
      - **prorrogacaoInternacao** (string) - Hospitalization extension.
      - **anexoOPME** (string) - OPME attachment.
      - **anexoQuimioterapia** (string) - Chemotherapy attachment.
      - **anexoRadioterapia** (string) - Radiotherapy attachment.
      - **profissionalSolicitante** (string) - Requesting professional.
    - **quantidade** (integer) - Total number of records exported.
  - **message** (object or null) - Message from the API, if any validation is needed.
    - **model** (Array of objects or null)
      - **model** (string) - Model name.
      - **field** (string) - Field name.
      - **errors** (Array of strings) - List of errors.
    - **system** (object or null)
      - **title** (string) - System message title.
      - **message** (string) - System message content.
      - **messageType** (integer) - Type of system message.
    - **suprimirAlerta** (Array of objects or null)
      - **titulo** (string) - Alert title.
      - **mensagem** (string) - Alert message.
      - **tipo** (integer) - Type of alert.

#### Error Response (400)
- **payload** (any or null) - Payload will be empty in case of error.
- **message** (object or null) - Message from the API, if any validation is needed.

#### Error Response (401)
- **message** (object or null) - Message from the API, if any validation is needed.
```

--------------------------------

### Successful Response for Radiotherapy Guides Export (200)

Source: https://open-api.prodoctor.net/api-docs/index.html

This is a sample successful response (200 OK) containing the exported radiotherapy guides and any associated messages. The payload includes details for each registered guide.

```json
{
  "payload": {
    "exportacao": {
      "registros": [
        {
          "codigoLocalProDoctor": "string",
          "localProDoctor": "string",
          "prontuario": "string",
          "paciente": "string",
          "convenio": "string",
          "dataSolicitacao": "string",
          "dataAutorizacao": "string",
          "senha": "string",
          "codigoProcedimento": "string",
          "descricaoProcedimento": "string",
          "linhaProcedimento": "string",
          "guia": "string",
          "numeroGuiaOperadora": "string",
          "profissionalSolicitante": "string",
          "tipoGuiaReferenciada": "string",
          "numeroGuiaReferenciada": "string"
        }
      ],
      "quantidade": 0
    }
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### Motivos de Retorno Response Sample

Source: https://open-api.prodoctor.net/api-docs/index.html

Example JSON response for the Motivos de Retorno endpoint, showing the structure for reasons and messages.

```json
{
  "payload": {
    "motivosRetorno": [
      {
        "codigo": 0,
        "nome": "string"
      }
    ]
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### Buscar Especialidades Response Sample

Source: https://open-api.prodoctor.net/api-docs/index.html

Example JSON response for the Buscar Especialidades endpoint, detailing the structure for returned specialties and messages.

```json
{
  "payload": {
    "especialidades": [
      {
        "codigo": 0,
        "nome": "string"
      }
    ]
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### Exemplo de Resposta JSON para Usuário Detalhado (200 OK)

Source: https://open-api.prodoctor.net/api-docs/index.html

Este snippet mostra a estrutura completa de uma resposta bem-sucedida ao detalhar um usuário. Inclui dados do usuário e mensagens opcionais.

```json
{
  "payload": {
    "usuario": {
      "codigo": 0,
      "nome": "string",
      "foto": "string",
      "estadoRegistro": 0,
      "titulo": "string",
      "endereco": {
        "logradouro": {
          "tipo": {
            "codigo": 0,
            "nome": "string"
          },
          "nome": "string"
        },
        "numero": 0,
        "complemento": "string",
        "cep": "string",
        "bairro": "string",
        "cidade": {
          "codigo": 0,
          "nome": "string"
        },
        "uf": {
          "codigo": 0,
          "nome": "string",
          "sigla": "string"
        },
        "pais": {
          "codigo": 0,
          "nome": "string"
        }
      },
      "tipo": 0,
      "cnpjcpf": "string",
      "cnes": "string",
      "especialidade": {
        "codigo": 0,
        "nome": "string"
      },
      "dadosConselho": {
        "conselhoProfissional": {
          "codigo": 0,
          "nome": "string",
          "sigla": "string"
        },
        "numero": "string",
        "uf": {
          "codigo": 0,
          "nome": "string",
          "sigla": "string"
        }
      },
      "configuracaoAgenda": {
        "turnos": [
          {
            "diaDaSemana": 1,
            "turno": 1,
            "inicio": "string",
            "final": "string",
            "duracao": "string"
          }
        ],
        "duracao": "string"
      },
      "cns": "string",
      "email": "string",
      "preferencias": {
        "agendaConsultasAtiva": true,
        "usuarioExecutaProcedimento": true,
        "atendeTeleconsultas": true
      },
      "dadosConselhoAlternativo": {
        "conselhoProfissional": {
          "codigo": 0,
          "nome": "string",
          "sigla": "string"
        },
        "numero": "string",
        "uf": {
          "codigo": 0,
          "nome": "string",
          "sigla": "string"
        }
      },
      "especialidadeAlternativa": {
        "codigo": 0,
        "nome": "string"
      }
    }
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### Excluir Imagem/Documento

Source: https://open-api.prodoctor.net/api-docs/index.html

Rota para excluir uma imagem/documento. Para utilizar esta rota é necessário dar a permissão à chave para Excluir em Imagens e Documentos. Somente uma imagem/documento criada pela própria chave da API pode ser excluída pela mesma.

```APIDOC
## DELETE /api/v1/ImagensDocumentos/Excluir/{codigo}

### Description
Rota para excluir uma imagem/documento.

### Method
DELETE

### Endpoint
/api/v1/ImagensDocumentos/Excluir/{codigo}

### Parameters
#### Path Parameters
- **codigo** (integer) - Required - Código de identificação da imagem/documento

### Responses
#### Success Response (204)
Sucesso

#### Error Response (400)
Dados de requisição inválidos
##### Response Schema: application/json
```json
{
  "payload": null,
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

#### Error Response (401)
Dados de autenticação inválidos
```

--------------------------------

### Buscar Convênios Response Sample (200 OK)

Source: https://open-api.prodoctor.net/api-docs/index.html

Sample JSON response for a successful request (200 OK) to search for convênios. It includes the payload with a list of convênios and a message object.

```json
{
  "payload": {
    "convenios": [
      {
        "codigo": 0,
        "nome": "string",
        "estadoRegistro": 0,
        "tipoConvenio": 0,
        "tabela": {
          "codigo": 0
        }
      }
    ]
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### Buscar Especialidades Request Sample

Source: https://open-api.prodoctor.net/api-docs/index.html

Example JSON payload for the Buscar Especialidades endpoint, used to search for specialties with active users.

```json
{
  "termo": "string",
  "campo": 0,
  "pagina": 1,
  "quantidade": 1
}
```

--------------------------------

### List Scheduled Returns for Patient (JSON Response Sample)

Source: https://open-api.prodoctor.net/api-docs/index.html

This is a sample JSON response for a successful request (200 OK) to the 'Retornos Programados' endpoint. It includes patient return details and potential API messages.

```json
{
  "payload": {
    "retornosProgramados": [
      {
        "linha": 0,
        "usuario": {
          "codigo": 0,
          "nome": "string"
},
        "data": "string",
        "motivoRetorno": {
          "codigo": 0,
          "nome": "string"
},
        "retornou": true
}
]
},
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
]
}
],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
},
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
}
]
}

}
```

--------------------------------

### GET /api/v1/AnamneseEvolucao/Detalhar/{codigo}

Source: https://open-api.prodoctor.net/api-docs/index.html

Retrieves detailed information for a specific anamnesis or evolution record of a patient. Requires read permissions for Anamneses and Evolutions.

```APIDOC
## GET /api/v1/AnamneseEvolucao/Detalhar/{codigo}

### Description
Retrieves detailed information for a specific anamnesis or evolution record of a patient. Requires read permissions for Anamneses and Evolutions.

### Method
GET

### Endpoint
https://open-api.prodoctor.net/api/v1/AnamneseEvolucao/Detalhar/{codigo}

### Parameters
#### Path Parameters
- **codigo** (integer): Required - The code of the anamnesis/evolution to be detailed.

### Responses
#### Success Response (200)
- **payload** (object or null): Payload containing the result of the anamnesis/evolution detail route.
- **message** (object or null): API message, if any validation is needed.

#### Error Response (400)
- **payload** (any or null): Payload will be empty in case of error.
- **message** (object or null): API message, if any validation is needed.

#### Error Response (401)
- **message** (object or null): API message, if any validation is needed.
```

--------------------------------

### Exemplo de Resposta 200 (Sucesso)

Source: https://open-api.prodoctor.net/api-docs/index.html

Este é um exemplo de resposta JSON bem-sucedida para a rota de busca de horários livres. O payload contém uma lista de agendamentos disponíveis, incluindo detalhes do local, usuário, data e hora.

```json
{
  "payload": {
    "agendamentos": [
      {
        "localProDoctor": {
          "codigo": 0,
          "nome": "string",
          "estadoRegistro": 0
        },
        "usuario": {
          "codigo": 0,
          "nome": "string",
          "especialidade": {
            "codigo": 0,
            "nome": "string"
          },
          "cpf": "string"
        },
        "data": "string",
        "hora": "string",
        "diaSemana": "string"
      }
    ]
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### Successful Response (200) for Storage Locations

Source: https://open-api.prodoctor.net/api-docs/index.html

Example of a successful JSON response when searching for storage locations. It contains a payload with a list of storage locations and a message object.

```json
{
  "payload": {
    "locaisArmazenamento": [
      {
        "codigo": 0,
        "nome": "string",
        "emprestimo": true,
        "localProDoctor": {
          "codigo": 0
        }
      }
    ]
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
        ]
      }
    ],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
    },
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
      }
    ]
  }
}
```

--------------------------------

### Exemplo de Resposta de Sucesso (200) para Exportação de Procedimentos

Source: https://open-api.prodoctor.net/api-docs/index.html

Este snippet ilustra o formato da resposta bem-sucedida da API, contendo o payload com a exportação dos procedimentos e uma mensagem opcional. O payload inclui detalhes de cada registro de procedimento.

```json
{
  "payload": {
    "exportacao": {
      "registros": [
        {
          "codigoLocalProDoctor": "string",
          "localProDoctor": "string",
          "paciente": "string",
          "convenio": "string",
          "numeroMatricula": "string",
          "fatura": "string",
          "conta": "string",
          "linhaProcedimento": "string",
          "dataHoraEntrada": "string",
          "acomodacao": "string",
          "data": "string",
          "usuario": "string",
          "funcao": "string",
          "funcaoRepasse": "string",
          "usuarioEspecialidade": "string",
          "codigoProcedimento": "string",
          "descricaoProcedimento": "string",
          "tipoProcedimento": "string",
          "grupoProcedimentosRepasses": "string",
          "grupoProcedimentosRelatorios": "string",
          "quantidade": "string",
          "valorTotal": "string",
          "valorDiferenca": "string",
          "valorGlosa": "string",
          "valorRecuperado": "string",
          "tipoGuia": "string",
          "guia": "string",
          "urgencia": "string",
          "dhe": "string",
          "apartamento": "string",
          "solicitante": "string",
          "numeroGuiaOperadora": "string",
          "tratamentoFinalizado": "string",
          "totalMateriaisMedicamentos": "string",
          "totalTaxasDiarias": "string",
          "totalGlosasMateriaisMedicamentos": "string",
          "totalGlosasTaxasDiarias": "string",
          "totalRecuperadoMateriaisMedicamentos": "string",
          "totalRecuperadoTaxasDiarias": "string",
          "bilateral": "string",
          "mesmaVia": "string",
          "viaDiferente": "string",
          "naoIncluirRepasse": "string",
          "somenteRepasse": "string",
          "naoRepassar": "string",
          "prontuario": "string",
          "solicitanteEspecialidade": "string"
}
],
      "quantidade": 0
    }
  },
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
]
}
],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
},
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
}
]
}

}
```

--------------------------------

### Successful Response for Listing Medical Procedure Tables

Source: https://open-api.prodoctor.net/api-docs/index.html

Example of a successful JSON response when listing medical procedure tables. It includes a payload with procedure details and a message object.

```json
{
  "payload": {
    "tabelasProcedimentos": [
      {
        "codigo": 0,
        "nome": "string",
        "tipoTabela": 0
}
]
},
  "message": {
    "model": [
      {
        "model": "string",
        "field": "string",
        "errors": [
          "string"
]
}
],
    "system": {
      "title": "string",
      "message": "string",
      "messageType": 0
},
    "suprimirAlerta": [
      {
        "titulo": "string",
        "mensagem": "string",
        "tipo": 0
}
]
}

}
```
Tokens:
Raw