Proyecto FEMI Salud Digital

Transcripción

1 Proyecto FEMI Salud Digital Documentación del Servicio Institucional para Obtener el Estado del Afiliado v1.1 Magdalena Hourcade Setiembre

2 Introducción El propósito del servicio es proveer información sobre el estado de afiliación de una persona en determinada institución. Uno de los usos de este servicio, es el de ser consultado por el Sistema de Autorizaciones, para poder realizar autorizaciones de algunas prestaciones asistenciales de forma automática. Interfaz A continuación se describe la interfaz del servicio, tomándose en cuenta la implementación de referencia, hecha por el proyecto FEMI Salud Digital, usando un servidor web Apache como punto de entrada y PHP cómo lenguaje de programación. Hecha esta salvedad, se aclara que cada institución puede elegir utilizar y adaptar la implementación de referencia ofrecida por el proyecto, o usar el servidor web y el lenguaje de programación que prefiera cada institución. Invocación al servicio Para invocar el servicio debe enviarse un HTTP (pedido HTTP), mediante método POST, por ejemplo a una URL: donde <servidor> es donde se instalaron los servicio. El se debe crear con los siguientes parámetros: Nombre Observaciones srv Nombre del servicio que se está invocando. Valores posibles: obtenerestadoafiliado Obligatorio, no admite valores nulos id_valor Valor del documento por el que se está consultando Valores posibles: Cualquier valor numérico Obligatorio, no admite valores nulos Id_tipo Tipo del documento por el que se está consultando Valores posibles: todos los valores de OID de documentos de personas que existen en el IMP de FEMI. Obligatorio, no admite valores nulos primer_nombre Primer nombre de la persona por la que se está consultando Valores posibles: Valores alfanuméricos segundo_nombre Segundo nombre de la persona por la que se está consultando Valores posibles: Valores alfanuméricos primer_apellido Primer apellido de la persona por la que se está consultando Valores posibles: Valores alfanuméricos segundo_apellido Segundo apellido de la persona por la que se está consultando Valores posibles: Valores alfanuméricos sexo Sexo de la persona por la que se está consultando Valores posibles: 'M', 'F', 'I' (masculino, femenino, indeterminado) 2

3 nacimiento_fecha Fecha de nacimiento de la persona por la que se está consultando Valores posibles: fechas con formato 'AAAAMMDDThhmmss' o AAAAMMDD. Debe tenerse en cuenta que en el caso que la fecha venga con el tiempo, el servicio solo tomará en cuenta la parte de la fecha AAAAMMDD para realizar la consulta. Descripción del HTTP Resquest Un HTTP está compuesto por varios headers (cabezales) y un body (cuerpo). Los headers indican la información sobre: el método HTTP que se quiere usar (POST) la URL a donde será enviado el pedido ( el protocolo que se utiliza y en qué versión (HTTP, 1.0/1.1) información sobre la conexión (persistente o no) información sobre el contenido del body (tipo, largo) El body contiene la información de los parámetros enviados. Por mas información sobre HTTP, referirse al documento RFC2616, donde se define el protocolo HTTP. Un request HTTP válido para el servicio obtenerestadoafiliado podría ser el siguiente: Content-Length: 133 srv=obtenerestadoafiliado&id_valor= &id_tipo= &primer_nombre=la ura&primer_apellido=perez&nacimiento_fecha= La primer linea indica el método (POST), la URL a donde se enviará el pedido ( y la versión del protocolo HTTP en uso (HTTP/1.0). La segunda linea indica el servidor () donde se enviará el pedido. En los siguientes headers encontramos información del tipo de contenido (Content- Type: application/x-www-form-urlencoded), si la conexión será persistente o no (), y el largo del contenido del pedido en bytes (Content-Length: 133). En el body encontramos la información que se envió para la consulta, o sea los parámetros del pedido HTTP. 3

4 Dentro de los parámetros, el valor de id_tipo en el caso del ejemplo es , que temporariamente será el OID que utilizaremos para la Cédula de Identidad uruguaya. Aquí puede acceder al listado de códigos que estamos usando para los distintos servicios federales: Salidas La salida del servicio es un código que representa, o bien el estado del afiliado pedido, o un código que marca algún tipo de error. En la siguiente tabla se muestran todos los códigos que debería devolver el servicio. Si en algún caso particular el servicio devuelve algo distinto a estos códigos, se considerará que hubo un error interno en el procesamiento del pedido. NO_ENCONTRADO ENCONTRADO_Y_ACTIVO ENCONTRADO_Y_NO_ACTIVO SERVICIO_NO_EXISTE SERVICIO_NO_ESPECIFICADO PARAMETROS_INSUFICIENTES TIPO_IDENTIFICADOR_FEMI_NO_EXISTE(XXX) TIPO_IDENTIFICADOR_NO_EXISTE(XXX) ERROR: La fecha de entrada XX-XX-XXXX no tiene la forma basica AAAAMMDDThhmmss El afiliado no se encuentra en la base de datos de la institución. En el caso que se haya encontrado a la persona en la institución y esté activa (por ejemplo que esté al día con la cuota) En el caso que se haya encontrado a la persona en la institución y no esté activa (por ejemplo que no esté al día con la cuota, que ya no sea afiliado de la institución, o que se haya atendido alguna vez pero no esté afiliado a la institución). Si el servicio recibido en el parámetro 'srv' no existe Si no se envió el parámetro 'srv' Si no se envió alguno de los parámetros 'id_valor' o 'id_tipo' Si el valor recibido en el parámetro 'id_ tipo' no es un OID válido para tipos de identificadores del IMP Si el valor recibido en el parámetro 'id_ tipo' no tiene su equivalente en la institución Si el parámetro 'nacimiento_fecha' no tiene el formato correcto 4

5 Ejemplos: Casos de éxito Persona encontrada y activa en la institución Content-Length: 63 srv=obtenerestadoafiliado&id_valor=99871&id_tipo= ENCONTRADO_Y_ACTIVO 5

6 Persona encontrada y no activa en la institución Content-Length: 63 srv=obtenerestadoafiliado&id_valor=99872&id_tipo= ENCONTRADO_Y_NO_ACTIVO Persona no encontrada en la institución Content-Length: 63 srv=obtenerestadoafiliado&id_valor=99873&id_tipo= NO_ENCONTRADO 6

7 Casos de error Servicio no existe Content-Length: 55 srv=obtenerestado&id_valor=99871&id_tipo= SERVICIO_NO_EXISTE Error en el formato de fecha de entrada Content-Length: 91 srv=obtenerestadoafiliado&id_valor=99870&id_tipo= &nacimiento_fecha=13/ 09/2010 ERROR: La fecha de entrada 13/09/2010 no tiene la forma basica AAAAMMDDThhmmss 7

8 Implementación de referencia La implementación desarrollada por el proyecto consta de un cliente, que envía pedidos para consultar el estado del afiliado, y un servidor que los recibe, procesa y responde. Cada institución puede elegir, o bien utilizar esta implementación y adaptarla a su institución, o basarse en ella para realizar una implementación en la tecnología que le resulte más familiar. Para probar la implementación, descargar el archivo: Esta es una implementación en PHP, que funciona sobre un servidor web Apache con soporte para PHP. Para poder probarlo, simplemente se descomprime el archivo descargado en la carpeta raíz del servidor web (llamada www o htdocs o public_html ). Deberá tener dos carpetas llamadas servicios y cliente. Con esto ya podrían realizar pruebas, accediendo a 8

9 En esta pagina encontrarán 6 formularios, que muestran los casos de prueba que se documentaron previamente. En cada formulario verán solo los datos (no son editables) que se enviarán al servicio para el caso de prueba, del que verán su respuesta al presionar el botón correspondiente en cada formulario. Uso de la implementación de referencia Si se desea utilizar la implementación de referencia para implementar este servicio en su institución, además de descomprimir las carpetas servicios y cliente en la raíz del servidor web, se debe conectar el servicio a la base de datos de la institución, configurar el archivo archivo IdPersona.php que se encuentra en el directorio servicios y crear la consulta SQL específica para la Base de datos de su institución. En el archivo IdPersona.php se implementa la conversión de los tipos de identificadores especificados mediante el parámetro id_tipo, desde los códigos federales a los códigos que utilice su institución. De esta forma, la interfaz del servicio es igual para cualquier institución, pero el servicio realiza las conversiones de valores de parámetros para cada institución particular. Conexión a la base de datos: Si cuentan con base de datos Informix, solo deben configurar los paramétros de la conexión. Estos se encuentran en el archivo Servicios.php del directorio servicios. Los encontrarán en el bloque CONSULTA. Si en cambio, tienen otra base de datos (MySQL, Postgres, SQLite) contactarse con el proyecto, ya que podemos proveerles de implementaciones de conexión a dichas bases en PHP. Configuración archivo IdPersona En este archivo se encuentra el mapeo de los OIDs del IMP de FEMI a los codigos de documentos de cada institución. Se debe completar el array, con los valores correspondientes. Consulta SQL. En el bloque consulta, deben sustituir en la linea 118, la consulta por defecto, por una consulta que busque en la base de datos si la persona existe en la misma, y si está activa (tiene un contrato activo y puede recibir asistencia). 9