Skip to content

Web Service TT (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.

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.

  • Si un parámetro es opcional, hay que pasar un espacio en blanco.

  • Las que incluyen parámetros de entrada en formato de fecha con inicio (START) y final (END) pueden tener una limitación, la cuál estará indicada en cada método.

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

  • En el caso de que la función indique horario restringido de obtención de datos, solo se permiten llamadas entre las 21:00h y las 10:59h.

Historial de cambios

Lista actualizada con los cambios realizados.

30/01/2025

  • Creación del documento.
Overview
URL

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

E-mail

soporte@ofimedic.com

Languages
Servers
Test

https://www.ofimedic.com/

Conexión

Prueba de conexión.

Operations

Disponibilidad

Búsqueda de datos de disponibilidad a partir de parámetros y valores indicados.

Operations

Citas

Respuesta de las acciones relativas a las citas en Ofimedic.

Operations

Obtención

Request

Obtiene las citas de Ofimedic.

Security
basicAuth
Query
USER_LIDstring

Identificador del paciente.

Example: USER_LID=1
APP_LIDstring

Identificador de la cita.

Example: APP_LID=1
START_DATEstring(date)

Fecha de inicio de la cita. Se indica en formato de fecha (dd/mm/aaaa).
Obligatorio indicar este parámetro si se cumple, como mínimo, uno de los 3 siguientes casos:
    - Si no se indica el parámetro APP_LID.
    - Si se indica el parámetro USER_LID.
    - Si se indica el parámetro RESOURCE_LID.

En caso de indicarlo, la diferencia de tiempo máxima entre este parámetro y END_DATE será de 31 días.
Debe ser anterior a END_DATE.

Example: START_DATE=01/01/2024
END_DATEstring(date)

Fecha de finalización de la cita. Se indica en formato de fecha (dd/mm/aaaa).
Obligatorio indicar este parámetro si no se indican los parámetros APP_LID, USER_LID y RESOURCE_LID.
En caso de indicarlo, la diferencia de tiempo máxima entre este parámetro y START_DATE será de 31 días.
Debe ser posterior a START_DATE.

Example: END_DATE=31/01/2024
RESOURCE_LIDstring

Identificador del facultativo.

Example: RESOURCE_LID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/GetAppointments?USER_LID=1&APP_LID=1&START_DATE=01%2F01%2F2024&END_DATE=31%2F01%2F2024&RESOURCE_LID=1'

Responses

Relación de citas

Bodyapplication/xmlArray [
APP_LIDinteger

Identificador de la cita.

Example: 1
APP_STATUSstring

Estado de la cita.
NotAttended si está Pendiente.
Cancelled si está Anulada.
Confirmed en en cualquier otro caso.

Example: "Confirmed"
APP_DATEstring(date)

Fecha de la cita.
Formato de fecha en "dd/mm/aaaa".

Example: "14/07/2023"
APP_START_TIMEstring(date)

Hora de inicio de la cita.
Formato de tiempo "hh:mm".

Example: "16:00"
APP_END_TIMEstring(date)

Finalización de la cita.
Formato de tiempo "hh:mm".

Example: "16:30"
APP_PRICEnumber(float)

Precio de la cita.
Admite decimales.

Example: 19.99
APP_CREATEDstring(datetime)

Fecha y hora de creación de la cita.
Formato de fecha y hora (dd/mm/aaaa hh:mm).

Example: "07/03/2014 00:00"
USER_LIDinteger

Identificador del paciente.

Example: 1
USER_FIRST_NAMEstring

Nombre del paciente.

Example: "A"
USER_SECOND_NAMEstring

Apellidos del paciente.

Example: "B"
USER_THIRD_NAMEstring

(Este campo siempre viene vacío)

USER_DATE_OF_BIRTHstring(date)

Fecha de nacimiento del paciente.

Example: "01/01/1970"
USER_PLACE_OF_BIRTHstring

Población del paciente.

Example: "Barcelona"
USER_ID_NUMBERstring

DNI del paciente.

Example: "00000000A"
USER_GENDERstring

Sexo del paciente:
M = hombre
F = mujer

Example: "M"
USER_ZIP_CODEstring

Código postal del paciente.

Example: "01234"
USER_LANGUAGEstring

Idioma del paciente.

USER_MOBILE_PHONEstring

Teléfono móvil del paciente.

Example: "600000000"
USER_LANDLINE_PHONEstring

Teléfono fijo del paciente.

Example: "900000000"
USER_WORK_PHONEstring

Teléfono del trabajo del paciente.

Example: "910000000"
USER_EMAILstring(email)

Email del paciente.

Example: "example@ofimedic.com"
USER_DATEstring(date)

Fecha de alta del paciente.

Example: "01/01/1970"
USER_PRIVACYinteger

1 si el paciente acepta el tratamiento de sus datos. 0 en caso contrario.

Example: 1
USER_PRIVACY_PROMOTIONSinteger

1 si acepta acciones de marketing. 0 en caso contrario.

Example: 1
COMMUNICATION_PREFERENCESinteger

Preferencias de comunicación del paciente.

ACTIVITY_IDinteger

Identificador del tipo de visita.

Example: 2
RESOURCE_IDinteger

Identificador del facultativo.

Example: 1
INSURANCE_IDinteger

Identificador de la compañía.

Example: 4
LOCATION_IDinteger

Identificador del centro/delegación.

Example: 2
]
Response
application/xml
<getAppointmentsResult>
  <RESULT>OK</RESULT>
  <Appointments>
    <Appointment>
      <APP_LID>4</APP_LID>
      <APP_STATUS>Confirmed</APP_STATUS>
      <APP_DATE>08/01/2023</APP_DATE>
      <APP_START_TIME>10:45</APP_START_TIME>
      <APP_END_TIME>10:55</APP_END_TIME>
      <APP_PRICE>0</APP_PRICE>
      <APP_CREATED>08/01/2023 00:00</APP_CREATED>
      <USER_LID>25</USER_LID>
      <USER_FIRST_NAME>Nombre</USER_FIRST_NAME>
      <USER_SECOND_NAME>Apellidos</USER_SECOND_NAME>
      <USER_THIRD_NAME/>
      <USER_DATE_OF_BIRTH>12/12/1974</USER_DATE_OF_BIRTH>
      <USER_PLACE_OF_BIRTH>Alicante</USER_PLACE_OF_BIRTH>
      <USER_ID_NUMBER>00000000A</USER_ID_NUMBER>
      <USER_GENDER>F</USER_GENDER>
      <USER_ZIP_CODE>03015</USER_ZIP_CODE>
      <USER_LANGUAGE/>
      <USER_MOBILE_PHONE>600000000</USER_MOBILE_PHONE>
      <USER_LANDLINE_PHONE>900000000</USER_LANDLINE_PHONE>
      <USER_WORK_PHONE>910000000</USER_WORK_PHONE>
      <USER_EMAIL>example@ofimedic.com</USER_EMAIL>
      <USER_PRIVACY>1</USER_PRIVACY>
      <USER_PRIVACY_PROMOTIONS>1</USER_PRIVACY_PROMOTIONS>
      <COMMUNICATION_PREFERENCES>111</COMMUNICATION_PREFERENCES>
      <ACTIVITY_LID>12</ACTIVITY_LID>
      <RESOURCE_LID>1</RESOURCE_LID>
      <INSURANCE_LID>1</INSURANCE_LID>
      <LOCATION_LID>1</LOCATION_LID>
    </Appointment>
  </Appointments>
</getAppointmentsResult>

Creación

Request

Crea una cita en Ofimedic.

Security
basicAuth
Query
AVAILABILITY_LIDstring

Identificador único de la operación.

Example: AVAILABILITY_LID=1
ACTIVITY_LIDstringrequired

Identificador del tipo de visita.

Example: ACTIVITY_LID=1
RESOURCE_LIDstringrequired

Identificador del facultativo.

Example: RESOURCE_LID=1
APP_DATEstring(date)required

Fecha de la cita. Se indica en formato de fecha (dd/mm/aaaa).

Example: APP_DATE=09/06/2022
APP_START_TIMEstring(time)required

Hora de inicio de la cita. Se indica en formato de hora (hh:mm).

Example: APP_START_TIME=08:00
USER_LIDstring

Identificador del paciente.
Obligatorio indicar este parámetro si no se indica el parámetro USER_ID_NUMBER.

Example: USER_LID=1
USER_FIRST_NAMEstring

Nombre del paciente.
Obligatorio indicar este parámetro si el parámetro USER_LID no existe en Ofimedic.

Example: USER_FIRST_NAME=Nombre
USER_SECOND_NAMEstring

Apellidos del paciente.
Solo es posible indicar este parámetro, de forma opcional, si el parámetro USER_LID no existe en Ofimedic.
En caso de que USER_LID exista, es obligatorio dejar este parámetro en blanco.

Example: USER_SECOND_NAME=Apellidos
USER_MOBILE_PHONEstring

Teléfono móvil del paciente.
Solo es posible indicar este parámetro, de forma opcional, si el parámetro USER_LID no existe en Ofimedic.
En caso de que USER_LID exista, es obligatorio dejar este parámetro en blanco.

Example: USER_MOBILE_PHONE=600000000
USER_EMAILstring

Email del paciente.
Solo es posible indicar este parámetro, de forma opcional, si el parámetro USER_LID no existe en Ofimedic.
En caso de que USER_LID exista, es obligatorio dejar este parámetro en blanco.

Example: USER_EMAIL=email@example.com
USER_ID_NUMBERstring

DNI/NIF del paciente.
Obligatorio indicar este parámetro si no se indica el parámetro USER_LID.

Example: USER_ID_NUMBER=00000000A
LOCATION_LIDstring

Identificador del centro/delegación.

Example: LOCATION_LID=1
INSURANCE_LIDstring

Identificador de la compañía.

Example: INSURANCE_LID=1
APP_NOTESstring

Observaciones de la cita.

FROM_PORTALstring

Origen de la creación de la cita

USER_SUBSCRIPTIONstring

Número de filiación del paciente

Example: USER_SUBSCRIPTION=1
curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/AddAppointment?AVAILABILITY_LID=1&ACTIVITY_LID=1&RESOURCE_LID=1&APP_DATE=09%2F06%2F2022&APP_START_TIME=08%3A00&USER_LID=1&USER_FIRST_NAME=Nombre&USER_SECOND_NAME=Apellidos&USER_MOBILE_PHONE=600000000&USER_EMAIL=email%40example.com&USER_ID_NUMBER=00000000A&LOCATION_LID=1&INSURANCE_LID=1&APP_NOTES=string&FROM_PORTAL=string&USER_SUBSCRIPTION=1'

Responses

Resultado

Bodyapplication/xmlArray [
RESULTstring

Respuesta de creación de la cita.
OK en caso de creación correcta.
ERROR en caso de error.

Example: "OK"
ERROR_MESSAGEstring

Descripción del error en caso de que RESULT sea ERROR.

APP_LIDinteger

Identificador de la cita.

Example: 1
USER_LIDinteger

Identificador del paciente.

Example: 2
]
Response
application/xml
<addAppointmentResult>
  <ADD_RESULT>OK</ADD_RESULT>
  <ERROR_MESSAGE/>
  <APP_LID>9163</APP_LID>
  <USER_LID>0</USER_LID>
</addAppointmentResult>

Modificación

Request

Modifica una cita en Ofimedic.

Security
basicAuth
Query
APP_LIDstring

Identificador de la cita.

Example: APP_LID=1
USER_LIDstring

Identificador del paciente.

Example: USER_LID=1
APP_STATUSstring

“ANULADA” para anular la cita y “NO_ANULADA” para quitar la marca de anulación.

curl -i -X GET \
  -u <username>:<password> \
  'https://www.ofimedic.com/UpdateAppointment?APP_LID=1&USER_LID=1&APP_STATUS=string'

Responses

Resultado

Bodyapplication/xmlArray [
RESULTstring

Respuesta de modificación de la cita.
OK en caso de modificación correcta.
ERROR en caso de error.

Example: "OK"
ERROR_MESSAGEstring

Descripción del error en caso de que RESULT sea ERROR.

]
Response
application/xml
<updateAppointmentResult>
  <UPDATE_RESULT>OK</UPDATE_RESULT>
  <ERROR_MESSAGE/>
</updateAppointmentResult>

Eliminación

Request

Elimina una cita en Ofimedic.

Security
basicAuth
Query
APP_LIDstringrequired

Identificador de la cita.

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

Responses

Resultado

Bodyapplication/xmlArray [
RESULTstring

Respuesta de eliminación de la cita.
OK en caso de eliminación correcta.
ERROR en caso de error.

Example: "OK"
ERROR_MESSAGEstring

Descripción del error en caso de que RESULT sea ERROR.

APP_LIDinteger

Identificador de la cita.

Example: 1
]
Response
application/xml
<deleteAppointmentResult>
  <DELETE_RESULT>OK</DELETE_RESULT>
  <ERROR_MESSAGE/>
  <APP_LID>1</APP_LID>
</deleteAppointmentResult>

Obtención de listados

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

Operations

Pagos

Respuesta de las acciones relativas a los pagos en Ofimedic.

Operations