Resultado de exames

Owned by Ranniêr Reis
Last updated: mai. 12, 2021
7 min read

Tópicos:

Objetivo

Este documento tem como objetivo orientar a construção de um webservice para retornar os dados necessários para demonstrar os exames laboratoriais e os exames por imagem, com a possibilidade de visualizar os exames, imprimir e compartilhar via arquivo PDF.

Necessidade

Disponibilizar aos beneficiários da operadora os exames laboratoriais e por imagem realizados, bem como seus detalhes.

As regras de negócio relativos a exibição ou não dos exames devem ser feitas por seus sistemas, enviando apenas dados que devem ser demonstrados no aplicativo.

Solução Proposta

A Mobile Saúde propõe um layout de integração para que a operadora construa um webservice que fornecerá dados suficientes para apresentação clara e objetiva dos resultados de exames.

Padrões de webservices

  • Este WebService deve ser construído obrigatoriamente em padrão REST.

  • Por padrão, todas as requisições dessa integração utilizam o método POST.

Endpoint

Método

Header Content-Type

exemplo.com/nomeDoMetodoRequisitado



Atenção:

O endpoint obrigatoriamente deve terminar com o nome padronizado pelo método.



POST

application/json



Atenção:

A criação dos webservices fora do padrão descritos neste documento, ocasionarão total mudança de projeto, tempo de entrega e valores.

Critérios de preenchimento

Abreviação

Nome

Descrição

M

Mandatório

O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu arquivo será rejeitado.

C

Condicional

O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.

Quando não obrigatório o conteúdo pode ser informado em branco.

OP

Opcional

Seu preenchimento não é obrigatório. Podendo o conteúdo estar em branco.

Objetos e atributos de retorno

Atenção:

Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.

Exemplo do atributo "chaveBeneficiario":

  • chave_beneficiario

  • ch_beneficiario

  • chave-beneficiario

  • chaveBeneficiario 

Obrigatoriedade

Além dos webservices descritos nesta documentação, a integração desta funcionalidade depende primáriamente da implementação de webservices de login, descritos no link desta documentação (clique aqui).

Listagem de métodos

  • examesLaboratoriais

  • examesLaboratoriaisLaudo

  • listaSeriesEstudo

  • listaImagensEstudo

  • examesPorImagem

  • laudoImagemPdf

Método: examesLaboratoriais

Descrição do Serviço

Este serviço é utilizado para retornar a lista de exames laboratoriais por data.

Regras de negócio

Este webservice deverá receber a chave do beneficiário, data inicial e data final.

Parâmetros de entrada

critério

campos

tipo

descrição

1

M

chaveBeneficiario

String

Informe o código que identifica o beneficiário no seu sistema de gestão, de modo que este sistema possa reconhecer, validar e retornar os lançamentos de resultados de exames vinculado a ele.



2

M

dataInicial

String

Data inicial referente a período requisitado pelo usuário.



3

M

dataFinal

String

Data final referente a período requisitado pelo usuário.



Estrutura retorno

critério

campos

tipo

descrição

1

M

status

Boolean

True == indica que a requisição foi bem sucedida.
False == Indica que a requisição foi mal sucedida

2

C

critica

String

Quando o status for igual a false, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição.



3

M

data

Array de objetos

Retornar um array de estruturas “data“ (definição abaixo).

Cada elemento dentro deste array representa um exame do beneficiário que está logado no sistema e que possui lançamento de exames a ser demonstrado na listagem.



Definição da estrutura “data”

Cada elemento dentro deste array representa um exame do beneficiário que está logado no sistema e que possui lançamento de exames a ser demonstrado na listagem.

critério

campos

tipo

descrição

1

OP

acNumber

String

Número de acompanhamento do exame laboratorial

2

M

data

Date

Data do exame laboratorial.



3

M

docCarteira

String

Carteira do exame laboratorial

4

M

docGuia

String

Guia do exame laboratorial

5

OP

docIdDoCop

String

Id do documento

6

OP

laudo

String

Laudo do exame laboratorial

7

M

local

String

Local do exame laboratorial

8

M

laudado

Booleam

True == indica que o exame foi laudado.
False == Indica que o exame não foi laudado.

9

M

procedimentos

String

Procedimentos realizados no exame laboratorial

10

M

prontuario

String

Número do prontuário do exame laboratorial

11

OP

situacao

String

Situação do exame laboratorial

12

OP

solicitante

String

Beneficiário que solicitou o exame laboratorial

13

OP

tipoExame

String

Tipo do exame laboratorial





Método: examesLaboratoriaisLaudo

Descrição do Serviço

Este serviço é utilizado para retornar o laudo do exame laboratorial.

Regras de negócio

Este webservice deverá receber a chave do beneficiário, data inicial e data final;

Parâmetros de entrada

critério

campos

tipo

descrição

1

M

chaveBeneficiario

String

Informe o código que identifica o beneficiário no seu sistema de gestão, de modo que este sistema possa reconhecer, validar e retornar os lançamentos de resultados de exames vinculado a ele.



2

M

docGuia

String

Guia do exame laboratorial.

3

M

docIdDoCop

String

Id do documento.

Estrutura de retorno

critério

campos

tipo

descrição

1

M

status

Boolean

True == indica que a requisição foi bem sucedida.
False == Indica que a requisição foi mal sucedida

2

C

critica

String

Quando o status for igual a false, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição.



3

M

data

Array de objetos

Retornar um array de estruturas “data“ (definição abaixo).

Definição da estrutura “data”

A string desse elemento representa o link do PDF com o laudo.

critério

campos

tipo

descrição

1

M

data

String

PDF ou HTML do laudo.



Método: listaSeriesEstudo

Descrição do Serviço

Este serviço é utilizado para retornar a lista das séries de estudo dos exames por imagem.

Regras de negócio

Este webservice deverá receber a chave do beneficiário, data inicial e data final;

Parâmetros de entrada

critério

campos

tipo

descrição

1

M

acNumber

String

Número de acompanhamento do exame laboratorial.

2

M

prontuario

String

Número do prontuário do exame laboratorial.

Estrutura de retorno

critério

campos

tipo

descrição

1

M

status

Boolean

True == indica que a requisição foi bem sucedida.
False == Indica que a requisição foi mal sucedida

2

C

critica

String

Quando o status for igual a false, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição.



3

M

data

Array de objetos

Retornar um array de estruturas “data“ (definição abaixo).

Definição da estrutura “data”

A string desse elemento representa o link do PDF com o laudo.

critério

campos

tipo

descrição

1

M

seriesUID

String

String com o id da série de estudo

2

M

seriesDescription

String

Descrição da série de estudo

3

M

studyDescription

String

Descrição do estudo



Método: listaImagensEstudo

Descrição do Serviço

Este serviço é utilizado para retornar as imagens do exame por imagem, dado um id da série de estudo.

Regras de negócio

Este webservice deverá receber o id da série de estudo;

Parâmetros de entrada

critério

campos

tipo

descrição

1

M

seriesUID

String

ID da série de estudo.

Estrutura de retorno

critério

campos

tipo

descrição

1

M

status

Boolean

True == indica que a requisição foi bem sucedida.
False == Indica que a requisição foi mal sucedida

2

C

critica

String

Quando o status for igual a false, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição.



3

M

data

Array de objetos

Retornar um array de estruturas “data“ (definição abaixo).

Cada elemento dentro deste array representa uma imagem do resultado da série de estudo.

Definição da estrutura “data”

Cada elemento dentro deste array representa uma imagem do resultado da série de estudo.

critério

campos

tipo

descrição

1

M

instanceUID

String

ID Unico da instancia

2

M

serieUID

String

ID da série de estudo

3

M

studyUID

String

ID da descrição de estudo

4

M

imagemURL

String

Url da imagem



Método: examesPorImagem

Descrição do Serviço

Este serviço é utilizado para retornar a lista de exames por imagem.

Regras de negócio

Este webservice deverá receber a chave do beneficiário, data inicial e data final;

Parâmetros de entrada

critério

campos

tipo

descrição

1

M

chaveBeneficiario

String

Informe o código que identifica o beneficiário no seu sistema de gestão, de modo que este sistema possa reconhecer, validar e retornar os lançamentos de resultados de exames vinculado a ele.



2

M

dataInicial

String

Data inicial referente a período requisitado pelo usuário.



3

M

dataFinal

String

Data final referente a período requisitado pelo usuário.



Estrutura de retorno

critério

campos

tipo

descrição

1

M

status

Boolean

True == indica que a requisição foi bem sucedida.
False == Indica que a requisição foi mal sucedida

2

C

critica

String

Quando o status for igual a false, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição.



3

M

data

Array de objetos

Retornar um array de estruturas “data“ (definição abaixo).

Cada elemento dentro deste array representa um exame por imagem.

Definição da estrutura “data”

Cada elemento dentro deste array representa uma imagem do resultado da série de estudo.

critério

campos

tipo

descrição

1

OP

acNumber

String

Número de acompanhamento do exame por imagem

2

M

data

Date

Data do exame por imagem. 



3

M

docGuia

String

ID da descrição de estudo

4

OP

docIdDoCop

String

Url da imagem

5

M

laudo

String

Número Laudo do exame por imagem

6

M

local

String

Local do exame por imagem

7

M

procedimentos

String

Procedimentos realizados no exame por imagem

8

M

laudado

Boolean

True == indica que o exame foi laudado.
False == Indica que o exame não foi laudado.



Método: laudoImagemPdf

Descrição do Serviço

Este serviço é utilizado para retornar o laudo do exame por imagem.

Regras de negócio

Este webservice deverá receber a chave do beneficiário, data inicial e data final;

Parâmetros de entrada

critério

campos

tipo

descrição

1

M

strLaudo

String

Número Laudo do exame por imagem

2

M

strProntuario

String

Número do prontuário do exame por imagem

3

M

strAcNumber

String

Número do acompanhamento do exame por imagem

4

M

strLaudado

String

String com “true” ou “false” se tiver o não laudo

Estrutura de retorno

critério

campos

tipo

descrição

1

M

status

Boolean

True == indica que a requisição foi bem sucedida.
False == Indica que a requisição foi mal sucedida

2

C

critica

String

Quando o status for igual a false, envie nesta propriedade o motivo pelo qual não foi possível realizar a requisição.



3

M

data

Array de string

Retornar uma string (definição abaixo).

Definição estrutura "data"

critério

campos

tipo

descrição

1

M

data

String

PDF ou HTML do laudo





Mobile Saúde - 2019