MIPRES NoPBS

DOCUMENTACIN WEB SERVICES Versin 3.1

Diciembre 2016

Tabla de Contenido

1. Documentacin del Servicio Rest WSprescripcin................................................ 2

2. Cliente Para Probar los Mtodos Expuestos en el Servicio REST ........................ 5
3. PRESCRIPCIN ........................................................................................................ 7
3.1. Parmetros de consulta mtodo Prescripcin ....................................................... 7
3.2. Parmetros consulta mtodo Prescripcin por paciente ...................................... 8
3.3. Parmetros consulta mtodo Prescripcin por nmero de prescripcin ............ 9
3.4. Parmetros de consulta mtodo Novedades Prescripcin ................................. 10
4. TUTELAS ................................................................................................................. 11
4.1. Parmetros de consulta mtodo Tutelas .............................................................. 11
4.2. Parmetros consulta mtodo Tutelas por paciente ............................................. 12
4.3. Parmetros consulta mtodo Tutelas por nmero de prescripcin ................... 13
4.4. Parmetros de consulta mtodo Novedades Tutelas .......................................... 14
5. SUMINISTROS ......................................................................................................... 15
6. TIPOS DE RESPUESTA DEL SERVICIO ................................................................ 18
6.1. Respuestas Cdigo 2XX (SUCCESS) .................................................................... 18
6.2. Respuestas Cdigo 4XX (CLIENT ERROR) ........................................................... 19

Pgina 1 de 21 ASIF07- Versin 1

1. Documentacin del Servicio Rest WSprescripcin

En este documento se explica cmo se pueden consumir en modo de prueba los mtodos que se disponen a
travs del servicio REST en formato JSON.

Los mtodos se relacionan con:

Prescripcin, el cual devuelve para una fecha especfica las prescripciones de un NIT.
Prescripcin por paciente, el cual devuelve las prescripciones de un paciente para una fecha especfica
de un NIT.
Novedades, el cual devuelve las novedades de prescripciones para una fecha especfica de un NIT.

La URL de acceso a la documentacin es: http://tablas.sispro.gov.co/wsmipresnopbs/Help

Cuando se ingresa se muestra la siguiente informacin

EJEMPLO: Documentacin del mtodo Prescripcion

2
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
Cuando se hace clic sobre el link del mtodo GET, se muestra la siguiente informacin

En esta pgina se encuentra la informacin de la respuesta de este mtodo. Para este caso en particular la
respuesta es una lista de prescripciones cada una de ellas con una lista de Medicamentos, una lista de
Procedimientos, una lista de Dispositivos, una lista de ProductosNutricionales y una lista de
ServiciosComplementarios.

En cada uno de estos links se encuentra el detalle campo por campo de la estructura de las listas.

Y la respuesta de este servicio en formato JSON

3
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
 4
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
2. Cliente Para Probar los Mtodos Expuestos en el Servicio REST

El cliente que utilizaremos para probar los servicios es SWAGGER, este cliente permite desde una interfaz grfica
visualizar el resultado de consumir cada uno de los mtodos expuestos en el servicio de WSMIPRES.

La URL de acceso a la documentacin es: http://tablas.sispro.gov.co/wsmipresnopbs/Help

En el men superior est el botn

5
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
En esta pgina se encuentran los mtodos expuestos y se puede probar contra la informacin de la base de datos
de pruebas.

6
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
3. PRESCRIPCIN
3.1. Parmetros de consulta mtodo Prescripcin

Para consultar el servicio de Prescripcin se deben enviar tres parmetros.

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

Fecha formato (AAAA-MM-DD). en la URL se debe ingresar la fecha
TOKEN - PIN de seguridad nico por entidad. en la URL el Token

Cabe anotar que la concatenacin de parmetros se realiza con el smbolo /

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/Prescripcion/8901100100/2016-10-05/1

Esta direccin retorna un objeto JSON con la lista de prescripciones realizadas en la fecha seleccionada para la
institucin ingresada.

Visualizacin

En el navegador Internet Explorer

En el navegador CHROME

7
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
3.2. Parmetros consulta mtodo Prescripcin por paciente

Para consultar el servicio de Prescripcin por paciente se deben enviar cinco parmetros

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

Fecha formato (AAAA-MM-DD). en la URL se debe ingresar la fecha
TOKEN - PIN de seguridad nico por entidad. en la URL el Token
Tipo Documento Paciente en la URL valor (CC, RC, TI, CE, PA, NV, CD, SC y PR)
Nmero Documento Paciente en la URL ingresar el nmero de documento

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/PrescripcionPaciente/8901100100/2016-10-05/1/CC/123

Consulta vista desde el cliente Swagger

8
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
3.3. Parmetros consulta mtodo Prescripcin por nmero de prescripcin

Para consultar el servicio de Prescripcin por nmero de prescripcin se deben enviar tres parmetros

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

TOKEN - PIN de seguridad nico por entidad. en la URL el Token
Nmero Prescripcin en la URL ingresar el nmero de la prescripcin

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/PrescripcionXNumero/8901100100/1/20161005126000000029

Consulta vista con el cliente Swagger

9
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
3.4. Parmetros de consulta mtodo Novedades Prescripcin

Para consultar el servicio de Novedades se deben enviar tres parmetros.

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

Fecha formato (AAAA-MM-DD). en la URL se debe ingresar la fecha
TOKEN - PIN de seguridad nico por entidad. en la URL el Token

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/NovedadesPrescripcion/8901100100/2016-11-13/1

Visualizacin con el cliente Swagger

En el navegador Internet Explorer

10
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
4. TUTELAS
4.1. Parmetros de consulta mtodo Tutelas

Para consultar el servicio de Tutelas se deben enviar tres parmetros.

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

Fecha formato (AAAA-MM-DD). en la URL se debe ingresar la fecha
TOKEN - PIN de seguridad nico por entidad. en la URL el Token

Cabe anotar que la concatenacin de parmetros se realiza con el smbolo /

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/Tutelas/8901100100/2016-10-05/AAAA

Esta direccin retorna un objeto JSON con la lista de tutelas registradas en la fecha seleccionada para la
institucin ingresada.
Visualizacin en el navegador Internet Explorer

Visualizacin con el cliente Swagger

11
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
4.2. Parmetros consulta mtodo Tutelas por paciente

Para consultar el servicio de Tutelas por Paciente se deben enviar cinco parmetros

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

Fecha formato (AAAA-MM-DD). en la URL se debe ingresar la fecha
TOKEN - PIN de seguridad nico por entidad. en la URL el Token
Tipo Documento Paciente en la URL valor (CC, RC, TI, CE, PA, NV, CD, SC y PR)
Nmero Documento Paciente en la URL ingresar el nmero de documento

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/TutelaXPaciente/8901100100/2016-10-05/1/CC/123

Consulta vista desde el cliente Swagger

12
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
4.3. Parmetros consulta mtodo Tutelas por nmero de prescripcin

Para consultar el servicio de Tutelas por nmero de prescripcin se deben enviar tres parmetros

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

TOKEN - PIN de seguridad nico por entidad. en la URL el Token
Nmero Prescripcin en la URL ingresar el nmero de la prescripcin

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/TutelaXNumero/8901100100/AAAA/20160928120000000027

Consulta vista con el cliente Swagger

13
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
4.4. Parmetros de consulta mtodo Novedades Tutelas

Para consultar el servicio de Novedades de Tuteas se deben enviar tres parmetros.

NIT de la EPS/IPS. en la URL se debe ingresar nicamente el nit

Fecha formato (AAAA-MM-DD). en la URL se debe ingresar la fecha
TOKEN - PIN de seguridad nico por entidad. en la URL el Token

La forma como se debe construir la URL de peticin es la siguiente

http://tablas.sispro.gov.co/wsmipresnopbs/api/NovedadesTutelas/8901100100/2016-11-13/1

Visualizacin con el cliente Swagger

14
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
5. SUMINISTROS

Para este mtodo es necesario tener una herramienta para enviar la informacin ya que todos los mtodos reciben
en la URL los parmetros bsicos de NIT y TOKEN. Pero se deben pasar luego de estos, los siguientes datos a
travs de un objeto de tipo JSON con la informacin que se solicita en el anexo tcnico de suministros.

Con el cliente Swagger, se puede visualizar el mtodo expuesto

La URL se podra escribir de la siguiente manera

http:// tablas.sispro.gov.co/wsmipresnopbs/api/Suministro/9999999999/AAAAA

Los otros parmetros se envan en un objeto tipo JSON. A continuacin, un ejemplo de cmo se pueden enviar
los valores requeridos, en este caso para el objeto Dispositivo

Tipos de respuesta del servicio

15
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
 16
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
Cuando se realiza una insercin exitosa a travs del cliente Swagger, se visualiza el objeto de respuesta de la
siguiente manera

Cuando se tiene una respuesta fallida por error de datos se visualiza de esta manera

17
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
6. TIPOS DE RESPUESTA DEL SERVICIO

Para todos los mtodos anteriormente descritos se tienen los tipos de respuesta definidos en el estndar HTTP 1.
En este servicio se utilizan cdigos de tipo 2XX, tipo 4XX y tipo 5XX

6.1. Respuestas Cdigo 2XX (SUCCESS)

Cdigo 200. Este cdigo corresponde a respuesta exitosa con retorno, es decir, todas las consultas o inserciones
realizadas exitosamente que retornan resultado.

1 https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

18
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
Cdigo 204. Este cdigo corresponde a respuesta exitosa sin retorno, es decir, todas las consultas o inserciones
que son realizadas no tienen informacin, pero no es fall del servicio. Por esta razn van acompaadas del
mensaje no content.

6.2. Respuestas Cdigo 4XX (CLIENT ERROR)

Cdigo 400 Bad Request. Este tipo de respuesta se entrega cuando se envan datos errados en el request, o
sintaxis incorrecta-

- Fecha Invlida.

19
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
 - Tipo de documento paciente errado
-

-
- TOKEN O NIT Incorrecto
-

20
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)
Cdigo 404 Not Found. Este tipo de respuesta se entrega cuando el servidor no encuentra el recurso solicitado,
esto puede ocurrir porque se envan menos parmetros de los esperados o se puede enviar un nombre de mtodo
que no existe en la definicin del Servicio.

Cdigo 422 Validacin de Datos

Este error se presenta cuando se realiza una solicitud que no cumple con la integridad referencial o no
pasa las validaciones.
{

El objeto retornado consiste en un mensaje y una lista de errores.

21
SIG-F05 VERSIN 2 (28 DE NOVIEMBRE DEL 2014)