Ofimedic Cita Online (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.

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

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

  • 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. Se indican las fechas y la descripción de los cambios. Se muestra del cambio más reciente al más antiguo.

30/01/2025

  • Modificaciones en GetAppointments:
    • Inclusión de los campos APP_ARRIVAL_TIME, APP_ENTER_TIME, APP_EXIT_TIME y APP_STATEID.
    • Eliminación del campo APP_CREATED.

23/12/2024

  • Adecuación del documento y modificaciones en SearchAvailabilities, CheckAvailavility y GetAppointments.

23/01/2024

  • Creación del documento.
Overview
URL

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

E-mail

soporte@ofimedic.com

Languages
Servers
Test

https://ws.ofimedic.com/citaonlinews/test/services.asmx/

Conexión

Prueba de conexión.

Operations

Citas

Respuesta de las acciones relativas a las citas en Ofimedic.

Operations

Disponibilidad

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

Operations

Obtención de listados

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

Operations

Delegaciones

Request

Obtiene los centros/delegaciones de Ofimedic.

Query
LOCATION_IDstring

Identificador del centro/delegación.

Example: LOCATION_ID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://ws.ofimedic.com/citaonlinews/test/services.asmx/GetLocations?LOCATION_ID=1'

Responses

Relación de delegaciones

Bodyapplication/jsonArray [
LOCATION_IDinteger

Identificador del centro/delegación.

Example: 1
LOCATION_NAMEstring

Nombre del centro/delegación.

Example: "A"
LOCATION_ADRESSstring

Dirección del centro/delegación.

Example: "Barcelona"
LOCATION_ZIP_CODEstring

Código postal del centro/delegación.

Example: "01234"
LOCATION_CITYstring

Población del centro/delegación.

Example: "Barcelona"
LOCATION_PROVINCEstring

Provincia del centro/delegación.

Example: "Barcelona"
LOCATION_COUNTRYstring

País del centro/delegación.

Example: "España"
LOCATION_PHONEstring

Teléfono del centro/delegación.

Example: "900000000"
LOCATION_EMAILstring(email)

Email del centro/delegación.

Example: "example@correo.com"
]
Response
application/json
[
  {
    "LOCATION_ID": 1,
    "LOCATION_NAME": "Delegación 1",
    "LOCATION_ADRESS": "Calle Ejemplo 1",
    "LOCATION_ZIP_CODE": "00000",
    "LOCATION_CITY": "Madrid",
    "LOCATION_PROVINCE": "Madrid",
    "LOCATION_COUNTRY": "España",
    "LOCATION_PHONE": "900000000",
    "LOCATION_EMAIL": "email@ejemplo.com"
  }
]

Facultativos

Request

Obtiene los facultativos de Ofimedic.

Query
LOCATION_IDstring

Identificador del centro/delegación.

Example: LOCATION_ID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://ws.ofimedic.com/citaonlinews/test/services.asmx/GetResources?LOCATION_ID=1'

Responses

Relación de facultativos

Bodyapplication/jsonArray [
RESOURCE_IDinteger

Identificador del facultativo.

Example: 1
RESOURCE_FIRST_NAMEstring

Nombre del facultativo.

Example: "A"
RESOURCE_SECOND_NAMEstring

Apellidos del facultativo.

Example: "B"
RESOURCE_MOBILE_PHONEstring

Teléfono móvil del facultativo.

Example: "600000000"
LOCATION_EMAILstring(email)

Email del facultativo.

Example: "example@correo.com"
RESOURCE_ID_NUMBERstring

DNI del facultativo.

Example: "00000000A"
AVAILABILITIES_STEPinteger

Intervalo del facultativo.

Example: 4
LOCATION_IDinteger

Identificador del centro/delegación.

Example: 1
]
Response
application/json
[
  {
    "RESOURCE_ID": 1,
    "RESOURCE_FIRST_NAME": "A",
    "RESOURCE_SECOND_NAME": "B",
    "RESOURCE_MOBILE_PHONE": "600000000",
    "LOCATION_EMAIL": "example@correo.com",
    "RESOURCE_ID_NUMBER": "00000000A",
    "AVAILABILITIES_STEP": 4,
    "LOCATION_ID": 1
  }
]

Pacientes

Request

Obtiene los pacientes de Ofimedic.

Query
PATIENT_IDstring

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

Example: PATIENT_ID=1
PATIENT_ID_NUMBERstring

Documento de identificación del paciente (DNI, NIE, etc.).
Obligatorio indicar este parámetro si no se indica el parámetro PATIENT_ID.

Example: PATIENT_ID_NUMBER=00000000A
curl -i -X GET \
  -u <username>:<password> \
  'https://ws.ofimedic.com/citaonlinews/test/services.asmx/GetPatients?PATIENT_ID=1&PATIENT_ID_NUMBER=00000000A'

Responses

Relación de pacientes

Bodyapplication/jsonArray [
PATIENT_IDinteger

Identificador del paciente.

Example: 1
PATIENT_FIRST_NAMEstring

Nombre del paciente.

Example: "A"
PATIENT_SECOND_NAMEstring

Apellidos del paciente.

Example: "A"
PATIENT_DATE_OF_BIRTHstring(date)

Fecha de nacimiento del paciente.

Example: "01/01/1970"
PATIENT_PLACE_OF_BIRTHstring

Población del paciente.

Example: "Barcelona"
PATIENT_ID_NUMBERstring

DNI del paciente.

Example: "00000000A"
PATIENT_GENDERstring

Sexo del paciente:
H = hombre
M = mujer

Example: "H"
PATIENT_ZIP_CODEstring

Código postal del paciente.

Example: "01234"
PATIENT_INSURANCE_IDinteger

Identificador de la tarifa.

Example: 1
PATIENT_LANDLINE_PHONEstring

Teléfono fijo del paciente.

Example: "900000000"
PATIENT_MOBILE_PHONEstring

Teléfono móvil del paciente.

Example: "600000000"
PATIENT_WORK_PHONEstring

Teléfono del trabajo del paciente.

Example: "910000000"
PATIENT_EMAILstring(email)

Email del paciente.

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

Fecha de alta del paciente.

Example: "01/01/1970"
PATIENT_PRIVACYinteger

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

Example: 1
PATIENT_PRIVACY_PROMOTIONSinteger

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

Example: 1
]
Response
application/json
[
  {
    "PATIENT_ID": 1,
    "PATIENT_FIRST_NAME": "A",
    "PATIENT_SECOND_NAME": "A",
    "PATIENT_DATE_OF_BIRTH": "01/01/1970",
    "PATIENT_PLACE_OF_BIRTH": "Barcelona",
    "PATIENT_ID_NUMBER": "00000000A",
    "PATIENT_GENDER": "H",
    "PATIENT_ZIP_CODE": "01234",
    "PATIENT_INSURANCE_ID": 1,
    "PATIENT_LANDLINE_PHONE": "900000000",
    "PATIENT_MOBILE_PHONE": "600000000",
    "PATIENT_WORK_PHONE": "910000000",
    "PATIENT_EMAIL": "example@ofimedic.com",
    "PATIENT_DATE": "01/01/1970",
    "PATIENT_PRIVACY": 1,
    "PATIENT_PRIVACY_PROMOTIONS": 1
  }
]

Tarifas

Request

Obtiene las tarifas de Ofimedic.

Query
RESOURCE_IDstring

Identificador del facultativo.

Example: RESOURCE_ID=1
ACTIVITY_IDstring

Identificador del tipo de visita.

Example: ACTIVITY_ID=1
TYPEinteger

Tipo de tarifa a devolver.
Si se deja este parámetro vacío se devuelven todas las tarifas.
0 para devolver sólo las tarifas privadas.
1 para devolver sólo las compañías.

curl -i -X GET \
  -u <username>:<password> \
  'https://ws.ofimedic.com/citaonlinews/test/services.asmx/GetInsurances?ACTIVITY_ID=1&RESOURCE_ID=1&TYPE=0'

Responses

Relación de tipos de visita

Bodyapplication/jsonArray [
INSURANCE_IDinteger

Identificador de la tarifa.

Example: 1
INSURANCE_NAMEstring

Nombre de la tarifa.

Example: "Tarifa privada"
TYPEinteger

Tipo de tarifa.
0 = tarifas privadas.
1 = compañías.

Example: 0
]
Response
application/json
[
  {
    "INSURANCE_ID": 1,
    "INSURANCE_NAME": "Tarifa privada",
    "TYPE": 0
  }
]

Tipos de visita

Request

Obtiene los tipos de visita de Ofimedic.

Query
RESOURCE_IDstring

Identificador del facultativo.

Example: RESOURCE_ID=1
INSURANCE_IDstring

Identificador de la compañía.

Example: INSURANCE_ID=1
curl -i -X GET \
  -u <username>:<password> \
  'https://ws.ofimedic.com/citaonlinews/test/services.asmx/GetActivities?INSURANCE_ID=1&RESOURCE_ID=1'

Responses

Relación de tipos de visita

Bodyapplication/jsonArray [
ACTIVITY_IDinteger

Identificador del tipo de visita.

Example: 1
ACTIVITY_NAMEstring

Nombre del tipo de visita.

Example: "Primer tipo de visita"
ACTIVITY_DURATIONinteger

Duración del tipo de visita.
Se indica en minutos.

Example: 15
ACTIVITY_PRICEnumber(float)

Base Imponible del servicio asociado.
Se muestra sólo si se informa de los parámetros de entrada RESOURCE_ID e INSURANCE_ID.
Admite decimales.

Example: 49.99
ACTIVITY_SPECIALTY_IDinteger

Identificador de la especialidad del tipo de visita.

Example: 1
ACTIVITY_SPECIALTY_NAMEstring

Nombre de la especialidad del tipo de visita.

Example: "Especialidad 1"
ACTIVITY_APPOINTMENT_TYPEstring

Tipos de atención disponibles del facultativo.
Se muestra en una matriz los tipos de atención disponibles, con el nombre y su código.
Se muestra sólo si se informa del parámetro de entrada RESOURCE_ID.

Example: "Primer tipo de visita, 1"
]
Response
application/json
[
  {
    "ACTIVITY_ID": 1,
    "ACTIVITY_NAME": "Primer tipo de visita",
    "ACTIVITY_DURATION": 15,
    "ACTIVITY_PRICE": 49.99,
    "ACTIVITY_SPECIALTY_ID": 1,
    "ACTIVITY_SPECIALTY_NAME": "Especialidad 1",
    "ACTIVITY_APPOINTMENT_TYPE": "Primer tipo de visita, 1"
  }
]