Web Service CM (1.0.0)

Introducción

Especificaciones de los métodos que permiten interactuar con la información almacenada en las bases de datos de Ofimedic en el Centro Médico.

Especificaciones

  • La URL para acceder al servicio tendrá la siguiente estructura:
    • http://{URL}/services.asmx/{NombreMétodo}
    • https://{URL}/services.asmx/{NombreMétodo}

  • Los parámetros de entrada que son obligatorios están marcados como tal.
    • Hay parámetros de entrada que pueden no estar marcados como obligatorios, pero que lo sean bajo ciertas condiciones, las cuales están indicadas.

  • Todos los mensajes de respuesta estarán formateados en JSON.

Historial de cambios

Lista actualizada con los cambios realizados. Se indican las fechas y la descripción de los cambios. Se muestra del cambio más reciente al más antiguo.

07/04/2022

  • Creación de la función SendDocumentosEmail.

11/03/2022

  • Modificación en GetSociedades: Inclusión de la tarifa "Particular".

03/03/2022

  • Modificación en BusquedaCitaNueva: Los días disponibles a buscar pasan de 15 a 45.

21/01/2022

  • Modificación en GetFacultativosByEspecialidadAndSociedad: Inclusión del parámetro de entrada TipoAtencion.

12/11/2021

  • Modificación en GetDocumentosImagenes: Inclusión del campo NombreArchivo.

29/10/2021

  • Modificación en GetDocumentosImagenes: Modificación del parámetro Año.

06/10/2021

  • Modificación en GetDocumentosImagenes: Inclusión de los parámetros TipoDocumentoID, Mes y Año.

04/10/2021

  • Modificación en GetDocumentoImagen: Modificación del parámetro SubtipoDocumentoID para obtener los resultados de las pruebas.

08/09/2021

  • Modificación en LoginFacultativo: Inclusión del parámetro SoloDesdeHora.
  • Modificación en BusquedaCitaNueva: Inclusión del parámetro SoloDesdeHora.

03/09/2021

  • Modificación en BusquedaCitaNueva: Los días disponibles a buscar pasan de 7 a 15.
Overview
URL

https://www.ofimedic.com/soporte/asistencia.asp

E-mail

soporte@ofimedic.com

Languages
Servers
Test

https://www.ofimedic.com/

Autenticación

Prueba de conexión.

Operations

Citas

Respuesta de las acciones relativas a las citas en Ofimedic.

Operations

Descargas

Respuesta de acciones relacionadas con la descarga de archivos específicos.

Operations

Envío

Envíos de tipos de datos por vías específicas.

Operations

Obtención de listados

Obtiene las listas con los datos a partir de los valores especificados.

Operations

Citas

Request

Devuelve los datos de una cita.

Query
CitaIDintegerrequired

Identificador de la cita.

Example: CitaID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetCita?CitaID=1'

Responses

Información de la cita

Bodyapplication/jsonArray [
Fechastring(date)

Fecha de la cita.

Example: "05/07/2023"
Horastring(time)

Hora de la cita.

Example: "08:00"
FacultativoIDinteger

Identificador del facultativo.

Example: 1
Facultativostring

Nombre del facultativo.

Example: "Facultativo 1"
EspecialidadIDinteger

Identificador de la especialidad.
Si no tiene ninguna, aparece un 0.

Example: 1
Estadostring

Estado de la cita.

Example: "Finalizada"
TipoAtencionstring

Tipo de atención asignado a la cita.

Example: "Presencial"
EnlaceVideoconferenciastring

Enlace a la videoconferencia de Jitsi.

SociedadIDinteger

Identificador de la sociedad.

Example: 1
Nombrestring

Nombre de la sociedad.

Example: "Sociedad 1"
]
Response
application/json
[
  {
    "Fecha": "05/07/2023",
    "Hora": "08:00",
    "FacultativoID": 1,
    "Facultativo": "Facultativo 1",
    "EspecialidadID": 1,
    "Estado": "Finalizada",
    "TipoAtencion": "Presencial",
    "EnlaceVideoconferencia": "",
    "SociedadID": 1,
    "Nombre": "Sociedad 1"
  }
]

Citas por paciente

Request

Lista las citas de un paciente de los últimos 3 meses.

Query
PacienteIDintegerrequired

Identificador del paciente.

Example: PacienteID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetCitasByPaciente?PacienteID=1'

Responses

Relación de citas del paciente

Bodyapplication/jsonArray [
CitaIDinteger

Identificador de la cita.

Example: 1
Fechastring(date)

Fecha de la cita.

Example: "05/07/2023"
Horastring(time)

Hora de la cita.

Example: "08:00"
FacultativoIDinteger

Identificador del facultativo.

Example: 1
Facultativostring

Nombre del facultativo.

Example: "Facultativo 1"
EspecialidadIDinteger

Identificador de la especialidad.
Si no tiene ninguna, aparece un 0.

Example: 1
Estadostring

Estado de la cita.

Example: "Finalizada"
TipoAtencionstring

Tipo de atención asignado a la cita.

Example: "Presencial"
EnlaceVideoconferenciastring

Enlace a la videoconferencia de Jitsi.

SociedadIDinteger

Identificador de la sociedad.

Example: 1
Nombrestring

Nombre de la sociedad.

Example: "Sociedad 1"
]
Response
application/json
[
  {
    "CitaID": 1,
    "Fecha": "05/07/2023",
    "Hora": "08:00",
    "FacultativoID": 1,
    "Facultativo": "Facultativo 1",
    "EspecialidadID": 1,
    "Estado": "Finalizada",
    "TipoAtencion": "Presencial",
    "EnlaceVideoconferencia": "",
    "SociedadID": 1,
    "Nombre": "Sociedad 1"
  }
]

Documentos e imágenes

Request

Devuelve una lista de los documentos e imágenes de un paciente.

Query
PacienteIDintegerrequired

Identificador del paciente.

Example: PacienteID=1
TipoDocumentoIDintegerrequired

Identificador del tipo de documento.
Este valor se puede obtener en el método GetTiposDocumentoActuacion.

Example: TipoDocumentoID=1
Mesinteger

Mes del cual se van a mostrar los registros.
Obligatorio indicar este parámetro si no se indica el parámetro Año.
En caso de no indicar Año, se tendrá en cuenta el año actual.

Example: Mes=4
Añointeger

Año del cual se van a mostrar los registros.
Obligatorio indicar este parámetro si no se indica el parámetro Mes.
En caso de no indicar Mes, se tendrá en cuenta todo el Año indicado.

Example: Año=2023
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetDocumentosImagenes?A%C3%B1o=2023&Mes=4&PacienteID=1&TipoDocumentoID=1'

Responses

Relación de documentos e imágenes del paciente

Bodyapplication/jsonArray [
Fechastring(date)

Fecha de la cita.

Example: "05/04/2023"
TipoDocumentoIDinteger

Identificador del tipo de documento.

Example: 1
TipoDocumentostring

Nombre del tipo de documento.

Example: "Documento revisión"
SubtipoDocumentoIDinteger

Identificador del subtipo de documento.

Example: 1
SubtipoDocumentostring

Nombre del subtipo de documento.

Example: "Subtipo"
DocumentoIDinteger

Identificador del documento.

Example: 1
FacultativoIDinteger

Identificador del facultativo.

Example: 1
Facultativostring

Nombre del facultativo.

Example: "Facultativo 1"
NombreArchivostring

Nombre del archivo.

Example: "Archivo foto"
]
Response
application/json
[
  {
    "Fecha": "05/04/2023",
    "TipoDocumentoID": 1,
    "TipoDocumento": "Documento revisión",
    "SubtipoDocumentoID": 1,
    "SubtipoDocumento": "Subtipo",
    "DocumentoID": 1,
    "FacultativoID": 1,
    "Facultativo": "Facultativo 1",
    "NombreArchivo": "Archivo foto"
  }
]

Especialidades

Request

Lista de todas las especialidades configuradas para la Cita Online.

curl -i -X GET \
  -u <username>:<password> \
  https://www.ofimedic.com/GetEspecialidades

Responses

Relación de especialidades

Bodyapplication/jsonArray [
EspecialidadIDinteger

Identificador de la especialidad.

Example: 1
Nombrestring

Nombre de la especialidad.

Example: "Especialidad 1"
]
Response
application/json
[
  {
    "EspecialidadID": 1,
    "Nombre": "Especialidad 1"
  }
]

Facultativos

Request

Devuelve los datos de un facultativo.

Query
FacultativoIDintegerrequired

Identificador del facultativo.

Example: FacultativoID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetFacultativo?FacultativoID=1'

Responses

Relación de facultativos

Bodyapplication/jsonArray [
Nombrestring

Nombre del facultativo.

Apellidosstring

Apellidos del facultativo.

EspecialidadesArray of objects
TiposAtencionArray of objects
]
Response
application/json
[
  {
    "Nombre": "Nombre",
    "Apellidos": "Apellidos",
    "Especialidades": [ … ],
    "TiposAtencion": [ … ]
  }
]

Facultativos por especialidad

Request

Lista de facultativos configurados para la Cita Online de una especialidad.

Query
EspecialidadIDintegerrequired

Identificador de la especialidad.

Example: EspecialidadID=1
SoloFacultativosActivosinteger

1 si se quiere mostrar solamente facultativos activos.
0 si se desea mostrar todos los facultativos.
Si no se indica este parámetro, su valor será, por defecto, 0.

Example: SoloFacultativosActivos=0
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetFacultativosByEspecialidad?EspecialidadID=1&SoloFacultativosActivos=0'

Responses

Relación de facultativos de la especialidad

Bodyapplication/jsonArray [
FacultativoIDinteger

Identificador del facultativo.

Example: 1
Facultativostring

Nombre del facultativo.

Example: "Facultativo 1"
]
Response
application/json
[
  {
    "FacultativoID": 1,
    "Facultativo": "Facultativo 1"
  }
]

Facultativos por sociedad

Request

Lista de facultativos configurados para la Cita Online de una sociedad.

Query
SociedadIDintegerrequired

Identificador de la sociedad.

Example: SociedadID=1
SoloFacultativosActivosinteger

1 si se quiere mostrar solamente facultativos activos.
0 si se desea mostrar todos los facultativos.
Si no se indica este parámetro, su valor será, por defecto, 0.

Example: SoloFacultativosActivos=0
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetFacultativosBySociedad?SociedadID=1&SoloFacultativosActivos=0'

Responses

Relación de facultativos de la sociedad

Bodyapplication/jsonArray [
FacultativoIDinteger

Identificador del facultativo.

Example: 1
Facultativostring

Nombre del facultativo.

Example: "Facultativo 1"
]
Response
application/json
[
  {
    "FacultativoID": 1,
    "Facultativo": "Facultativo 1"
  }
]

Facultativos por especialidad y sociedad

Request

Lista de facultativos configurados para la Cita Online de una especialidad y una sociedad.

Query
EspecialidadIDintegerrequired

Identificador de la especialidad.

Example: EspecialidadID=1
SociedadIDintegerrequired

Identificador de la sociedad.

Example: SociedadID=1
SoloFacultativosActivosinteger

1 si se quiere mostrar solamente facultativos activos.
0 si se desea mostrar todos los facultativos.
Si no se indica este parámetro, su valor será, por defecto, 0.

Example: SoloFacultativosActivos=0
TipoAtencionstring(number)

Tipo de atención de la visita:

0 = Presencial
1 = Online
2 = Domiciliaria

Si no se indica este valor, será, por defecto, 0.

Example: TipoAtencion=0
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetFacultativosByEspecialidadAndSociedad?EspecialidadID=1&SociedadID=1&SoloFacultativosActivos=0&TipoAtencion=0'

Responses

Relación de facultativos de la sociedad

Bodyapplication/jsonArray [
FacultativoIDinteger

Identificador del facultativo.

Example: 1
Facultativostring

Nombre del facultativo.

Example: "Facultativo 1"
]
Response
application/json
[
  {
    "FacultativoID": 1,
    "Facultativo": "Facultativo 1"
  }
]

Fecha

Request

Devuelve las citas de una fecha y un facultativo.

Query
FacultativoIDintegerrequired

Identificador del facultativo.

Example: FacultativoID=1
Fechastring(date)required

Fecha a consultar.

Example: Fecha=01/01/2025
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetCitasFacultativoByFecha?FacultativoID=1&Fecha=01%2F01%2F2025'

Responses

Relación de citas

Bodyapplication/jsonArray [
Fechastring(date)

Fecha de la cita.

Example: "05/07/2023"
Horastring(time)

Hora de la cita.

Example: "08:00"
TipoVisitastring

Nombre del tipo de visita.

Example: "Revisión"
Estadostring

Estado de la cita.

Example: "Finalizada"
Pacientestring

Paciente de la cita.

Example: "Facultativo 1"
TipoAtencionstring

Tipo de atención asignado a la cita.

Example: "Presencial"
]
Response
application/json
[
  {
    "Fecha": "05/07/2023",
    "Hora": "08:00",
    "TipoVisita": "Revisión",
    "Estado": "Finalizada",
    "Paciente": "Paciente 1",
    "TipoAtencion": "Presencial"
  }
]

Sociedades

Request

Lista de las sociedades marcadas como Mutua y la tarifa Particular con ID 28 configurado para la Cita Online.

curl -i -X GET \
  -u <username>:<password> \
  https://www.ofimedic.com/GetSociedades

Responses

Relación de sociedades

Bodyapplication/jsonArray [
SociedadIDinteger

Identificador de la sociedad.

Example: 1
Nombrestring

Nombre de la sociedad.

Example: "Sociedad 1"
]
Response
application/json
[
  {
    "SociedadID": 1,
    "Nombre": "Sociedad 1"
  }
]

Sociedades por paciente

Request

Lista de sociedades de un paciente.

Query
PacienteIDintegerrequired

Identificador del paciente.

Example: PacienteID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetSociedadesPaciente?PacienteID=1'

Responses

Relación de sociedades del paciente

Bodyapplication/jsonArray [
SociedadIDinteger

Identificador de la sociedad.

Example: 1
Nombrestring

Nombre de la sociedad.

Example: "Sociedad 1"
]
Response
application/json
[
  {
    "SociedadID": 1,
    "Nombre": "Sociedad 1"
  }
]

Tipos de documentos

Request

Devuelve una lista de los tipos de documento que puede haber en Ofimedic.

curl -i -X GET \
  -u <username>:<password> \
  https://www.ofimedic.com/GetTiposDocumentoActuacion

Responses

Datos de tipos de documentos

Bodyapplication/jsonArray [
TipoDocumentoIDinteger

Identificador del tipo de documento.

Example: 1
Descripcionstring

Nombre del tipo de documento.

Example: "Documento revisión"
NecesarioSubtipoDocumentoIDboolean

Indica si es necesario usar el subtipo de documento para operar con documentos.
True si es necesario.
False en caso contrario.

En caso de ser true, el parámetro de entrada SubtipoDocumentoID deberá indicarse siempre en los métodos donde se requiera su indicación.

Example: true
]
Response
application/json
[
  {
    "TipoDocumentoID": 1,
    "Descripcion": "Documento revisión",
    "NecesarioSubtipoDocumentoID": true
  }
]

Pacientes

Respuesta de acciones específicas relacionadas con pacientes.

Operations