Informe (Report)

En el objeto Report destacamos los siguientes campos.

• user_id: Identificador del usuario (User).
• type_code: Código del tipo de informe. Los valores de este campo pueden ser:
  • surgery
  • consultation
  • diagnosis
• datetime_at: Fecha del informe. Formato Y-m-d H:i:s. Obligatorio si no se envía "datetime_at_year".
• name: Nombre del informe.
• medic_id: Identificador del médico que hizo el informe (User). Se ignorará si se envía "assistance_id". Solo para el médico creador y para administradores.
• additional_data: Información adicional. Texto libre.
• pathologies: Array de identificadores de patologías (Pathology) para asociar al informe. El usuario establecido en la patología debe ser el mismo que el campo "user_id".

3.1. Servicios web

Recuperar Informe

https://developers.gadaca.com/#api-Reports-ReportGet

Obtener información del Informe por su ID.

Respuesta de ejemplo:

{
   "data": {
        "object": "Report",
        "id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "additional_data": "Lorem ipsum dolor sit amet...",
        "assistance_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "datetime_at": {
            "date": "2017-04-09 12:02:46.000000",
            "timezone_type": 3,
            "timezone": "Europe/Madrid"
        },
        "datetime_at_day": 9,
        "datetime_at_month": 4,
        "datetime_at_year": 2017,
        "domain_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "medic_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "medic_name": "Jose Luis Martínez Pérez",
        "name": "Operación cirugía torácica",
        "source_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "type_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "user_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "created_at": {
            "date": "2017-04-09 12:02:46.000000",
            "timezone_type": 3,
            "timezone": "Europe/Madrid"
        },
        "updated_at": {
            "date": "2017-06-26 21:00:02.000000",
            "timezone_type": 3,
            "timezone": "Europe/Madrid"
        },
        "source": {
            "data": {
                "object": "Category",
                "id": "xopxon45qlekj78m9gzy0avdbr96m37n",
                "code": "medic",
                "name": "Médico"
            }
        },
        "type": {
            "data": {
                "object": "Category",
                "id": "xopxon45qlekj78m9gzy0avdbr96m37n",
                "code": "surgery",
                "name": "Intervención"
            }
        }
    }
}

Recuperar archivos del Informe

Para recuperar los archivos adjuntos al informe, bastaría con usar el include "files" a la hora de recuperar la información del informe lo cual añadiría a la respuesta un objeto de este tipo:

[
    {
        "data": {
            "object": "File",
            "id": "xnowp9n75xz4r0dmvd6g8ma3kebjvyyb",
            "name": "My File Name",
            "real_name": "file.pdf",
            "category": "uploads",
            "path": "uploads/file.pdf",
            "extension": "pdf",
            "mime_type": "application/pdf",
            "size": "81237310",
            "url": "https://api.gadaca.com/files/xnowp9n75xz4r0dmvd6g8ma3kebjvyyb/download-binaries",
            "created_at": {
                "date": "2017-08-03 21:45:01.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "updated_at": {
                "date": "2017-08-03 21:45:01.000000",
                "timezone_type": 3,
                "timezone": "UTC"
            },
            "real_id": 1,
            "deleted_at": null
        }
    }
]

Descargar archivos del Informe

https://developers.gadaca.com/#api-Reports-ReportFileDownloadGet

Respondería un objeto de este tipo:

{
    "data": {
        "object": "File",
        "id": "xnowp9n75xz4r0dmvd6g8ma3kebjvyyb",
        "name": "My File Name",
        "real_name": "file.pdf",
        "category": "uploads",
        "path": "uploads/file.pdf",
        "extension": "pdf",
        "mime_type": "application/pdf",
        "size": "81237310",
        "url": "https://api.gadaca.com/files/xnowp9n75xz4r0dmvd6g8ma3kebjvyyb/download-binaries",
        "created_at": {
            "date": "2017-08-03 21:45:01.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_at": {
            "date": "2017-08-03 21:45:01.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "real_id": 1,
        "deleted_at": null
    }
}

Recuperar listado de Informe

Devuelve un listado de informes en base a los filtros que se soliciten. Los principales serían: user_id y type.code (surgery, consultation, diagnosis). Si se quiere incluir los archivos de cada informe, se debe indicar el include "files" en la petición.

https://developers.gadaca.com/#api-Reports-ReportListGet

El resultado sería un listado de objetos de tipo informe como el indicado en el comienzo del capítulo.

Crear Informe

Crea un informe con los parámetros requeridos.

https://developers.gadaca.com/#api-Reports-ReportPost

Los principales campos a usar para nuestras integraciones son los indicados en el comienzo del capítulo.

La respuesta será del tipo:

{
   "data": {
        "object": "Report",
        "id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "additional_data": "Lorem ipsum dolor sit amet...",
        "assistance_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "datetime_at": {
            "date": "2017-04-09 12:02:46.000000",
            "timezone_type": 3,
            "timezone": "Europe/Madrid"
        },
        "datetime_at_day": 9,
        "datetime_at_month": 4,
        "datetime_at_year": 2017,
        "domain_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "medic_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "medic_name": "Jose Luis Martínez Pérez",
        "name": "Operación cirugía torácica",
        "source_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "type_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "user_id": "xopxon45qlekj78m9gzy0avdbr96m37n",
        "created_at": {
            "date": "2017-04-09 12:02:46.000000",
            "timezone_type": 3,
            "timezone": "Europe/Madrid"
        },
        "updated_at": {
            "date": "2017-06-26 21:00:02.000000",
            "timezone_type": 3,
            "timezone": "Europe/Madrid"
        },
        "source": {
            "data": {
                "object": "Category",
                "id": "xopxon45qlekj78m9gzy0avdbr96m37n",
                "code": "medic",
                "name": "Médico"
            }
        },
        "type": {
            "data": {
                "object": "Category",
                "id": "xopxon45qlekj78m9gzy0avdbr96m37n",
                "code": "surgery",
                "name": "Intervención"
            }
        }
    }
}

Modificar Informe

Modifica los datos relativos a un informe

https://developers.gadaca.com/#api-Reports-ReportPut

La respuesa será del mismo tipo que la de la creación del informe.

Añadir archivos al Informe

Adjunta un archivo al informe anteriormente creado.

https://developers.gadaca.com/#api-Reports-ReportFilePost

El parámetro en la url "fileableId" se corresponde al ID del informe al cuál se quiere adjuntar el archivo.

La respuesta esperada será un objeto tipo File como el siguiente.

{
    "data": {
        "object": "File",
        "id": "xnowp9n75xz4r0dmvd6g8ma3kebjvyyb",
        "name": "My File Name",
        "real_name": "file.pdf",
        "category": "uploads",
        "path": "uploads/file.pdf",
        "extension": "pdf",
        "mime_type": "application/pdf",
        "size": "81237310",
        "url": "https://api.gadaca.com/files/xnowp9n75xz4r0dmvd6g8ma3kebjvyyb/download-binaries",
        "created_at": {
            "date": "2017-08-03 21:45:01.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "updated_at": {
            "date": "2017-08-03 21:45:01.000000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "real_id": 1,
        "deleted_at": null
    }
}

Eliminar archivo del Informe

Elimina un archivo perteneciente al informe.

https://developers.gadaca.com/#api-Reports-ReportFileDelete

De nuevo, el parámetro de la url "fileableId" se refiere al informe del cuál se quiere elminar el archivo.

La respuestá esperada debería ser:

{
    "message": "File ({real_id}) deleted"
}