====== Descripción de recursos como punto de atención ======

Descripción de los mensajes de respuesta al obtener recursos desde suap al hacer por ejemplo un GET o luego de generar un recurso con POST. En esta sección se consideran las interacciones con la url de punto de atención o laboratorio, las de [[:desarrolladores:webservice_uso:colegio|colegio]] pueden variar. Es decir, la url sería:

[[https://ws|https://ws]].**INSTALACION.** suap.com.ar/procesador/doV2/**recurso**
===== Orden =====

Al realizar un GET de un recurso orden existente o al intentar un POST de una orden para crearla en suap, obtendremos un JSON con la estructura ya mencionada, con las secciones ya mencionadas

|**<font 10pt:normal/Courier;;rgb(0,0,0);;inherit>Esquema de response general.</font>  ** \\ <font 10pt:normal/Courier;;rgb(0,0,0);;inherit>{"REST": {…},     \\ </font> <font 10pt:normal/Courier;;rgb(0,0,0);;inherit>“RENDER”: {…},     \\ </font> <font 10pt:normal/Courier;;rgb(0,0,0);;inherit>“STATUS” : {…},     \\ </font> <font 10pt:normal/Courier;;rgb(0,0,0);;inherit>“VIEW”: {…},     \\ </font> <font 10pt:normal/Courier;;rgb(0,0,0);;inherit>}</font>  |

Las particularidades de las secciones  STATUS y VIEW son tratadas en otra sección. Para REST y RENDER recordemos que son lo mismo pero REST tiene los links a los recursos y RENDER un digesto ya procesado para ser usado sin tener que realizar nuevas interacciones con el ws. Solamente detallaré RENDER indicando cuales de los aributos son entidades relacionadas.

==== RENDER ====

    * <nowiki>*</nowiki> **Token**: Es la identificación del recurso, es una letra O seguido del numero interno de orden de suap.
      * **_PuntoAtencion**: Es el identificador interno del punto de atención en suap. Un punto de atencion puede ser el laboratorio, un consultorio, un centro médico, etc.
      * **FechaRealizacion: **    Es la fecha en que se realizó la prestación en salud. No es la fecha de autorización ni de validación, es la fecha en que por ejemplo se realizó la extracción o la fecha en que se realizó la consulta.
      * **FechaPrescripcion: **    Es la fecha que figura en la receta en el caso de existir una. Generalmente es la fecha de la Rp.
      * **FechaAutorizacion: ** Es la fecha en la que se interactuó por ultima vez con el sistema del financiador. Se considera como fecha de consumo.
      * **DiagnosticoTexto: **    Es el texto del diagnóstico, generalmente ingresado por el personal recepcionista, no tiene codifcación alguna
      * **Observaciones: **    Observaciones sobre la orden.
      * **EstadoAutorizacion: **    Es el estado de [[:desarrolladores:webservice_uso:recursos_desde_punto_atencion#estadoautorizacion_orden|autorización de la orden. ]]Este estado es el de mayor jerarquía, es decir, que es necesario considerar este estado para definir luego que practicas son facturables o no.
      * **MensajeAutorizacion**: Es un mensaje de texto que refleja la condición de la orden, no es un mensaje útil para definir logicas de negocio. Si lo es para presentar al usuario.
      * **AnuladoPorPrestador**: Atributo booleano que indica si la orden fue anulada (True) o si no (False o null). Si la orden está anulada no debe considerarse como facturable en ninguna circunstancia.
      * **Borrador: **      Atributo booleano que indica que la orden está en borrador (True) o que es una orden totalmente consumida. Por ejemplo, una orden autorizada puede estar en borrador porque es un test sin ocacionarle consumo al afiliado. ** \\ **
      * **EstadoVerificacion**: Atributo booleano que indica si la orden está verificada por el colegio o por algún mecanismo interno del punto de atención. Depende de las políticas del colegio/asociación/circulo/etc puede repercutir en su condición de facturable o no. A la hora de definir realización o no de la prestación debería ignorarse esta condición. Solo se recomienda su consideración en procesos posteriores de cierre de periodo prestacional para facturar.
      * **NumeroOrden: **      Es el numero de orden como se muestra en el codigo de barras del ticket. ** \\ **
      * **ValorTotalAutorizado**: Es el importe total en pesos que se considera para facturar
      * **ValorTotalCoseguro**: Es el valor total en peso que se considera como coseguro
      * ** Sucursal**: En caso de tener sucursales, es la sucursal donde se realizó la gestión de autorización de la orden
      * **afiliado**: Es una colección de mas datos que identifican al afiliado. En la sección REST veríamos un link al recurso que tendríamos que seguir para poder obtener los datos del afiliado.    \\ <nowiki>*</nowiki> **Token**: Es la identificación del afiliado como recurso en suap
        * **NumeroAfiliado**: Es el número del afiliado según el convenio (en algunos financiadores es el cuit, otros el dni, otros un número inventado, etc)
        * **NombreCompuesto**: Es el nombre del afiliado compuesto por el apellido y el nombre en un solo string
        * **DocTipo**: Es el tipo de documento de identificación (LE, DNI, –, etc)
        * **DocNumero**: Es el número del documento de identificación
        * **obraSocial**: Es una colección de datos de la obra social del afilaido
          * **Token**: Es el identificador de la obra social, comienza con "OS" y continua con el Id interno de suap
          * **Nombre**: Es el nombre corto de la obra social
          * **ValorUnidadBioquimica**: es el valor vigente de la unidad bioquímica
      * **prestador**: Es una colección de mas datos que identifican al prestador efector. En la sección REST veríamos un link al recurso prestador.      \\ <nowiki>*</nowiki> **Token**: Es la identificación del recurso en suap, en este caso el prestador en este convenio
        * **MatriculaProvincial**: Es la matricula del prestador emitida por el organismo provincial.
        * **MatriculaNacional**: Es la matrícula del prestador emitida por el organismo de Capital Federal. En general nunca está informada
        * **NombreCompuesto**: Es el nombre de la persona (física o jurídica) prestador.
        * **DocTipo**: Es el tipo de documento del prestador
        * **DocNumero**: Es el número de documento del prestador
        * **obraSocial**:Es una colección de datos de la obra social del afilaido
          * **Token**: Es el identificador de la obra social, comienza con "OS" y continua con el Id interno de suap
          * **Nombre**: Es el nombre corto de la obra social
          * **ValorUnidadBioquimica**: es el valor vigente de la unidad bioquímica
      * **prescriptor**: Es una colección de mas datos que identifican al prescriptor de la rp. En la rección REST veríamos un link al recurso prescriptor.      \\ <nowiki>*</nowiki> **Token**: Es la identificación del recurso en suap, en este caso el prescriptor en este convenio
        * **MatriculaProvincial**: Es la matricula del prescriptor emitida por el organismo provincial.
        * **MatriculaNacional**: Es la matrícula del prescriptor emitida por el organismo de Capital Federal. En general nunca está informada
        * **NombreCompuesto**: Es el nombre de la persona (física o jurídica) prescriptor.
        * **DocTipo**: Es el tipo de documento del prescriptor
        * **DocNumero**: Es el número de documento del prescriptor
        * **obraSocial**:Es una colección de datos de la obra social del afilaido
          * **Token**: Es el identificador de la obra social, comienza con "OS" y continua con el Id interno de suap
          * **Nombre**: Es el nombre corto de la obra social
          * **ValorUnidadBioquimica**: es el valor vigente de la unidad bioquímica
      * **obraSocial**: Es un conjunto de datos de la obra social de la orden. En la sección REST veríamos un link al recurso obra social.      \\ <nowiki>*</nowiki> **Token**: Es el identificador de la obra social, comienza con "OS" y continua con el Id interno de suap
        * **Nombre**: Es el nombre corto de la obra social
        * **ValorUnidadBioquimica**: es el valor vigente de la unidad bioquímica
      * **itemsOrden**: Es una lista con los datos de cada prestación. Es decir, respeta la estructura {… "itemsOrden":**[**      {…}, {…}**]**…}. Dentro de cada {…}  veremos los siguientes datos:     \\ <nowiki>*</nowiki> **Token**: Es el identificador de la relación de una practica con esta orden. Comienza con PO. Es un dato bastante inutil, pero se deja por cuestiones de implementación.
        * **CodigoNomenclador**: Es el codigo de la prestación según el nomenclador pactado. No es el codigo que utiliza el financiador
        * **Nomenclador****: **     Es el nombre del nomenclador adoptado.
        * **Nombre****: **     Es el nombre de la practica
        * **EstadoAutorizacion****: **     Es el estado de autorizacion de la practica solamente.
        * **MensajeAutorizacion****:**      Es el mensaje en texto del estado de autorización de la practica, no sirve para reglas de negocio, es para que lea el operador.
        * **ValorTotal**: Es el valor de la prestación, sin importar su condición de autorización. Es decir, puede NO ESTAR SUMADO en el total de la orden, por ejemplo si es una practica rechazada.
        * **ValorCoseguro**: Es el valor del coseguro en el caso de ser posible un calculo por prestación. Hay convenios que no calculan el coseguro practica a practica, sino que lo hacen en un valor general de la orden.

==== Descripción de atributos ====

=== Borrador ===

En suap una orden puede estar en borrador. Es como el borrador de un mail que no se envió aun, es el ejemplo exacto. Cuando este flag está en "True" es porque la orden está en esa condición. Al estar en esta condición la orden no se debe facturar al financiador sin importar el estado general de la orden y el particular de las practicas. Es una especie de "verificación" previa.

=== Tipo ===

=== EstadoAutorizacion (orden): ===

|**EstadoAutorizacion**  |**Texto**  |**Explicación**  |
|0 |SIN_PROCESAR |La orden no pasó por ningún proceso de validación de forma completa |
|1 |AUTORIZADA |Todas las prestaciones contenidas en la orden están autorizadas. |
|2 |PARCIALMENTE_AUTORIZADA |Hay  por lo menos una prestación de la orden autorizada y el resto de las  prestaciones rechazadas. Esta orden contiene estrictamente prestaciones  que están autorizadas o rechazadas. |
|3 |REMITIDA_AUDITORIA |La orden en su totalidad está remitida a auditoría **a pesar de que contenga prestaciones autorizadas**. No es una orden consumible, está sujeta a la observación de un médico auditor la resolución. |
|4 |RECHAZADA |Todas las prestaciones de la orden están rechazadas. |
|5 |PARCIALMENTE_REMITIDA_AUDITORIA |La  orden presenta al menos una prestación autorizada y una prestación  remitida a auditoría. El resto de las practicas pueden estar rechazadas,  autorizadas o remitidas a auditoría. Las practicas autorizadas de la  orden se pueden consumir, pero las practicas pendientes pueden decantar  en un rechazo o autorización luego de que el médico auditor observe la  situación. |
|6 |AUTORIZADA_EXTRA_SISTEMA |La  orden puede ser facturada a pesar de no contar con una autorización por  sistema informático. Está autorizada por un aval en papel. Puede  requerir la carga de algún número de expediente o no. |
|7 |REMITIDA_AUDITORIA_ADM |Idem  el estado 3 pero será revisada por un auditor que no es médico. Esta  situación es para aplicar controles que no requieren criterios médicos  pero si debe ser revisado por un ser humano |
|8 |PARCIALMENTE_REMITIDA_AUDITORIA_ADM |Idem el estado 5 pero será revisada por un auditor que no es médico. |

=== EstadoAutorizacion (itemsOrden) ===

|EstadoAutorizacion |Texto |Explicación |
|0 |SIN_PROCESAR |La practica no fue considerada en el proceso de autorización. Solo debería ser el estado al ser creada, en general no debería obtenerse esto como una respuesta en el proceso de autorización. |
|1 |AUTORIZADA |La practica está autorizada, puede ser facturada si la orden a nivel cabecera está autorizada, parcialmente autorizada, parcialmente remitida a auditoría o en autorización externa. |
|2 |REMITIDA A AUDITORIA |La practica esa remitida a auditoría, no puede ser facturada al financiador |
|3 |RECHAZADA |La practica está rechazada, no puede ser facturada al financiador |
|6 |AUTORIZADA EXTRA SISTEMA |La practica está autorizada mediante tramites externos, puede ser facturada al financiador |

=== Orden que se puede facturar al financiador. ===

Al obtener un recurso de tipo orden mediante un GET se puede establecer si está en condiciones de ser facturada al financiador considerando lo siguiente:

    - El atributo Borrador debe estar en False
    - El atributo Tipo debe ser 'CONSUMO'
    - El atributo Token debe tener un valor diferente a nada o a null. Debe tener un valor string que comienza con una O seguido de su numero de identificación
    - El atributo AnuladoPorPrestador debe estar en False

|**orden →**  \\ ————         \\  **itemsOrden**  |**0 (S.P) **  |**1 (AUT)**  |**2 (P. AUT)**  |**3 (REM)**  |**4 (RECH)**  |**5 (P. REM)**  |**6 (AUT. EXT)**  |**7 (REM. ADM)**  |**8 (P. REM. ADM)**  |
|**0 (S.P.)**  |NO |NO |NO |NO |NO |NO |NO |NO |NO |
|**1 (AUT)**  |NO |**SI**  |**SI**  |NO |NO |**SI**  |**SI**  |NO |**SI**  |
|**2 (REM)**  |NO |NO |NO |NO |NO |NO |NO |NO |NO |
|**3 (RECH)**  |NO |NO |NO |NO |NO |NO |NO |NO |NO |
|**6 (AUT. EXT)**  |NO |**SI**  |**SI**  |NO |NO |**SI**  |**SI**  |NO |**SI**  |

Si la orden fuera el resultado de un request con el método POST que intentó crear una orden, debe considerarse ANTES el STATUS y chequear que ERROR esté vacío.

\\

===== obraSocial =====

==== Identificación de convenios x Token ====

A continucación se detalla la lista de tokens que identifica cada convenio en general. Para obtener el particular que se está operando en su instalación puede realizar un **search**   de obraSocial con algún criterio general como [..{"Nombre.contenga":""}..] y obtendrá la totalidad de los mismos con su respectivo token.

|Convenio |Token |
|IPROSS |OS1 |
|OSPLAD |OS2 |
|PAMI |OS3 |
|ACA SALUD |OS13 |
|CAJA FORENSE |OS14 |
|OSDE |OS5 |
|OBRA SOCIAL DE LA FRUTA |OS160 |
|OSPIL |OS165 |
|SANCOR SALUD |OS170 |
|SWISS MEDICAL GROUP |OS180 |
|OSPE |OS190 |
|SEMPRE |OS200 |
|JERARQUICOS SALUD |OS210 |
|GALENOS |OS220 |
|MEDIFE |OS230 |
|RED OMIP |OS240 |
|OSDIPP |OS250 |
|PREVENCION SALUD |OS260 |
|IOSFA |OS270 |
|DASU |OS280 |
|MEDICUS |OS290 |
|OSDEPYM |OS300 |
|SOSUNC |OS310 |
|PATRONES DE CABOTAJE |OS320 |
|FEDERADA SALUD |OS330 |
|ISSN |OS340 |
|OSPEPRI |OS350 |
|  |  |
|  |  |

\\