Programa de Controle Médico de Saúde Ocupacional
Modelo na Plataforma
Sigla: PCMSO
Descrição: Programa de Controle Médico de Saúde Ocupacional
Modelo Via API
Type: 44
Este modelo extrai informações-chave de um Programa de Controle Médico de Saúde Ocupacional (PCMSO).
O processo de extração é assíncrono e consiste em dois passos principais:
- Enviar o documento para a fila de processamento.
- Consultar o resultado após a conclusão do processamento.
Passo 1: Enviar o Documento para Processamento
Para iniciar a extração, envie uma requisição POST para o endpoint abaixo.
POST URL Ambiente/documents/upload
Headers
| Identificador | Valor |
|---|---|
Content-Type | multipart/form-data |
IDEXA-API-KEY | sua_api_key |
Payload (Corpo da Requisição)
A requisição deve conter os seguintes parâmetros obrigatórios:
| Parâmetro | Descriçao | Tipo |
|---|---|---|
files | O arquivo do documento a ser processado. | File |
type | Código interno do modelo. Use 44 para MEDICAL_CONTROL. | Integer |
Os parâmetros a seguir são opcionais:
| Parâmetro | Descriçao | Tipo |
|---|---|---|
pages | Define páginas específicas para análise (ex: "1,2,5-10"). | String |
externalId | Id externo para seu controle (não pode repetir). | String |
Exemplos de Requisição
- cURL
- JavaScript
- Python
- PHP
curl -X POST "URL_BASE/documents/upload" \
-H "IDEXA-API-KEY: sua_api_key" \
-H "Content-Type: multipart/form-data" \
-F "files=@/path/to/seu/documento.pdf" \
-F "type=44" \
-F "externalId=pedido-cliente-123"
const myHeaders = new Headers();
myHeaders.append("IDEXA-API-KEY", "sua_api_key");
const formdata = new FormData();
formdata.append("files", fileInput.files[0], "documento.pdf");
formdata.append("type", "44");
formdata.append("externalId", "pedido-cliente-123");
const requestOptions = { method: 'POST', headers: myHeaders, body: formdata };
fetch("URL_BASE/documents/upload", requestOptions)
.then(response => response.json())
.then(result => console.log(result));
import requests
url = "URL_BASE/documents/upload"
payload = {'type': '44', 'externalId': 'pedido-123'}
files=[('files',('documento.pdf',open('/path/to/documento.pdf','rb'),'application/pdf'))]
headers = {'IDEXA-API-KEY': 'sua_api_key'}
response = requests.request("POST", url, headers=headers, data=payload, files=files)
print(response.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "URL_BASE/documents/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'files' => new CURLFile('/path/to/documento.pdf'),
'type' => '44',
'externalId' => 'pedido-cliente-123'
],
CURLOPT_HTTPHEADER => [
"IDEXA-API-KEY: sua_api_key"
],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Resposta Imediata (Status 200)
A resposta confirma o recebimento. Guarde o id para consultar o resultado no próximo passo.
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 44,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:50.045Z"
}
A extração de dados pode levar alguns segundos. Por isso, a API funciona de forma assíncrona. Após enviar o documento, aguarde um momento e então use o id retornado para consultar o resultado final. Para ser notificado automaticamente, considere utilizar nossos Webhooks.
Passo 2: Consultar o Resultado
Use o id do documento para fazer uma requisição GET e buscar o resultado completo da extração.
GET URL Ambiente/documents/[id]
Resposta Final (Status 200)
Quando o status for 1 (FINISHED), o objeto data conterá os campos extraídos.
{
"id": "95893394-337c-429c-a63e-1b8210de47d2",
"externalId": "pedido-cliente-123",
"type": 44,
"data": {
"company": "EMPRESA A",
"issue_date": "2024-01-02",
"expiration_date": "2026-01-01",
"list_exams": "true",
"list_risks": "true",
"signature": "true",
"occupational_contexts": [
{
"position": "ASSISTENTE OPERACIONAL",
"risks": [
{
"group": "ERGONOMICO",
"agent": "FATORES BIOMECÂNICOS",
"description": "LOMBALGIAS"
}
],
"exams": [
{
"exam": "AV. CLINICA",
"types": "['ADMISSIONAL', 'PERIÓDICO']"
}
]
}
]
},
"processTime": 8.123,
"status": 1,
"statusDesc": "FINISHED",
"createdAt": "2026-01-07T14:38:50.045Z",
"updatedAt": "2026-01-07T14:38:58.168Z"
}
Dicionário de Dados: Programa de Controle Médico de Saúde Ocupacional
Estes são os campos retornados dentro do objeto data.
- Modelo
| Campo | Tipo | Descrição | Exemplo |
|---|---|---|---|
| company | String | Company | "EMPRESA A" |
| issueDate | String | Issue date | "2024-01-02" |
| expirationDate | String | Expiration date | "2026-01-01" |
| listExams | Boolean | Indicates whether the document has a list of exams by function | "true" |
| listRisks | Boolean | Indicates whether the document has a list of risks by function | "true" |
| signature | Boolean | Document's signature | "true" |
| occupationalContexts[].position | String | Indicates the person position | "ASSISTENTE OPERACIONAL" |
| occupationalContexts[].risks[].group | String | Risk's group | "ERGONOMICO" |
| occupationalContexts[].risks[].agent | String | Risk's agent | "FATORES BIOMECÂNICOS" |
| occupationalContexts[].risks[].description | String | Risk's description | "LOMBALGIAS" |
| occupationalContexts[].exams[].exam | String | Exam's exam | "AV. CLINICA" |
| occupationalContexts[].exams[].types | Array | Exam's type | "['ADMISSIONAL', 'PERIÓDICO']" |