CIMAVet REST API v1.
CIMAVet REST API
Tabla de contenido
Forma de acceso ........................................................................................................................... 2
Formato de los datos devueltos .................................................................................................... 2
Especificación ................................................................................................................................ 2
Medicamentos .......................................................................................................................... 2
Presentaciones .......................................................................................................................... 2
Notas de seguridad ................................................................................................................... 2
Maestras.................................................................................................................................... 2
Registro de cambios .................................................................................................................. 3
Tipos de datos complejos devueltos ............................................................................................. 3
Estado ........................................................................................................................................ 3
Documento ................................................................................................................................ 3
Nota ........................................................................................................................................... 3
ATC ............................................................................................................................................ 3
Presentación.............................................................................................................................. 4
PrincipioActivo .......................................................................................................................... 4
Excipiente .................................................................................................................................. 4
Medicamento ............................................................................................................................ 4
Lista de presentaciones ............................................................................................................. 5
Lista de medicamentos ............................................................................................................. 6
Item (Maestras) ......................................................................................................................... 6
Registro de cambios .................................................................................................................. 6
Recursos ........................................................................................................................................ 7
Parámetros comunes ................................................................................................................ 7
GET medicamentos?{condiciones} ............................................................................................ 7
GET medicamento?{condiciones} ............................................................................................. 8
GET presentaciones?{condiciones} ........................................................................................... 8
GET presentacion/{cn} .............................................................................................................. 8
GET maestras?{condiciones} ..................................................................................................... 9
GET/POST registroCambios?{condiciones} ............................................................................... 9
Agencia Española de Medicamentos y Productos Sanitarios 1
CIMAVet REST API v1.4
Forma de acceso
Todos los métodos indicados en el documento se forman desde la URL base
[Link]
Por ejemplo, si se desea invocar al método medicamento por número de registro para el ID
"1173 ESP" la URL será [Link]
ESP
Formato de los datos devueltos
Toda la información devuelta por los servicios REST descritos a continuación se encuentra en
formato JSON.
Especificación
Medicamentos
Recursos
Recurso Descripción
GET medicamentos?{condiciones} Devuelve una lista de medicamentos para las
condiciones enviadas
GET medicamento?{condiciones} Devuelve la información de un medicamento
pasando el nº de registro o el código nacional
Presentaciones
Recursos
Recurso Descripción
GET presentaciones?{condiciones} Devuelve una lista de presentaciones para las
condiciones enviadas
GET presentacion?{condiciones} Devuelve la información de una presentación pasando
el código nacional
Notas de seguridad
Recursos
Recurso Descripción
GET notas/:nregistro Devuelve una lista con las notas de seguridad
asociadas a un medicamento por número de registro
Maestras
Recursos
Recurso Descripción
GET maestras?{condiciones} Devuelve una lista de ítems con la información
Agencia Española de Medicamentos y Productos Sanitarios 2
CIMAVet REST API v1.4
Registro de cambios
Recursos
Recurso Descripción
GET registroCambios?{condiciones} Devuelve una lista de registro de cambios con los
medicamentos que han sido dados de alta, de baja
o modificados desde una fecha dada en adelante
Tipos de datos complejos devueltos
Estado
Devuelve la información de los estados de un medicamento. Si está autorizado solo devolverá
la fecha de autorización. Si está revocado o suspendido devolverá también esas fechas
Nombre Tipo Descripción
aut Fecha Fecha de autorización del medicamento/presentación
susp Fecha Fecha de suspensión del medicamento/presentación
rev Fecha Fecha de revocación del medicamento/presentación
Documento
Contiene la información relativa a los documentos asociados a un medicamento
Nombre Tipo Descripción
tipo Entero 1: Ficha Técnica, 2: Prospecto, 3: Informe Público Evaluación,
4: Plan de gestión de riesgos
url Texto URL para acceder al documento
secc Lógico Indica si el documento está disponible en HTML por
secciones
Nota
Contiene la información relativa a las notas de seguridad o informativas asociadas a un
medicamento
Nombre Tipo Descripción
tipo Entero 1: Nota Seguridad
num Texto Número de la nota
ref Texto Referencia asociada a la nota
asunto Texto Asunto asociado a la nota
fecha Fecha Fecha de publicación en la AEMPS
url Texto URL para acceder a la nota publicada en la AEMPS
ATC
Nombre Tipo Descripción
codigo Texto Código ATC
nombre Texto Nombre descriptivo
Nivel Entero Nivel del código ATC
Agencia Española de Medicamentos y Productos Sanitarios 3
CIMAVet REST API v1.4
Presentación
Nombre Tipo Descripción
cn Texto Código nacional de la presentación
nregistro Texto Nº de registro del medicamento
nombre Texto Nombre del medicamento
estado estado Estado de registro de la presentación
Comerc Lógico Indica si está comercializada o no
dispensacion Item Dispensación del formato
tipoMedicamento Item Tipo de medicamento
forma Item Forma farmacéutica
administracion Item Administración del medicamento
PrincipioActivo
Nombre Tipo Descripción
Id Entero ID de principio activo
codigo Texto Código identificativo del principio activo
nombre Texto Nombre del principio activo
cantidad Texto Cantidad de principio activo
unidad Texto Unidad para la cantidad
orden Entero Orden en la lista de principios activos de un medicamento
Excipiente
Nombre Tipo Descripción
Id Entero ID de excipiente
nombre Texto Nombre del excipiente
doe Lógico Declaración obligatoria
cantidad Texto Cantidad de excipiente
unidad Texto Unidad para la cantidad
orden Entero Orden en la lista de excipientes de un medicamento
Indicación/Contraindicación/Interacción
Nombre Tipo Descripción
Id Entero ID
nombre Texto Nombre
especie item Especia a la que se asocia
Reacción adversa
Nombre Tipo Descripción
Id Entero ID
nombre Texto Nombre
especie Maestra Especia a la que se asocia
frecuencia Maestra Frecuencia de aparición
Tiempo de espera
Nombre Tipo Descripción
cantidad Numérico Cantidad de tiempo
unidadTiempo Texto Unidad de tiempo
especie Maestra Especia a la que se asocia
frecuencia Maestra Frecuencia de aparición
Agencia Española de Medicamentos y Productos Sanitarios 4
CIMAVet REST API v1.4
Medicamento
Nombre Tipo Descripción
nregistro Texto Nº de registro del medicamento
nombre Texto Nombre del medicamento
pactivos Texto Listado de los principios activos separados por
comas
excip Texto Listado de los excipientes separados por comas
labtitular Texto Laboratorio titular del medicamento
dispensacion Maestra Requisito de dispensación
tipoMedicamento Maestra Tipo de medicamento
administracion Maestra Requisitos de administración
forma Maestra Forma farmacéutica
primeraAutorizacion Fecha Fecha de la primera autorización (Unix timestamp)
estado estado Estado de registro del medicamento
comerc Lógico Indica si tiene alguna presentación comercializada
psum Lógico Indica si tiene problemas de suministro
receta Lógico Indica si se necesita receta para su dispensación
estupefaciente Lógico Medicamento estupefaciente
psicotropo Lógico Medicamento psicótropo
antibiotico Lógico Medicamento antibiótico
notas Lógico Indica si existen notas asociadas al medicamento
ema Lógico Indica si el medicamento se ha registrado por
procedimiento centralizado (EMA) o no
docs documento[] Lista de documentos asociados al medicamento
atcs atc[] Lista de códigos ATC asociados al medicamento
principiosActivos principioActivo[] Lista de los principios activos del medicamento
excipientes Excipiente [] Lista de los excipientes del medicamento
viasAdministracion item[] Lista de las vías de administración para las que está
autorizado el medicamento
especies item[] Lista de especies destinos para las que está
autorizado el medicamento
indicaciones Item[] Lista de indicaciones por especie
contraindicaciones item[] Lista de contraindicaciones por especie
interacciones item[] Lista de interacciones por especie
reaccionesAdversas Item[] Lista de reacciones adversas
tiemposEspera item[] Lista con los tiempos de espera por especie y
tejido
presentaciones presentacion[] Lista de presentaciones del medicamento
Lista de presentaciones
Atributos
Nombre Tipo Descripción
nregistro Texto Nº de registro del medicamento
cn Texto Código nacional de la presentación
nombre Texto Nombre de la presentación
estado estado Estado de registro de la presentación
comerc Lógico Indica si está o no comercializada la presentación
Agencia Española de Medicamentos y Productos Sanitarios 5
CIMAVet REST API v1.4
Lista de medicamentos
Atributos
Nombre Tipo Descripción
nregistro Texto Nº de registro del medicamento
nombre Texto Nombre del medicamento
pactivos Texto Lista de principios activos separada por comas
excip Texto Lista de excipientes separada por comas
labtitular Texto Laboratorio titular del medicamento
dispensacion Maestra Requisito de dispensación
tipoMedicamento Maestra Tipo de medicamento
administracion Maestra Requisitos de administración
forma Maestra Forma farmacéutica
primeraAutorizacion Fecha Fecha de la primera autorización (Unix timestamp)
sitadm estado Situación administrativa
estado estado Estado de registro del medicamento
comerc Lógico Indica si tiene alguna presentación comercializada
receta Lógico Indica si se necesita receta para su dispensación
psum Lógico Indica si tiene problemas de suministro
cpresc Texto Condiciones de prescripción del medicamento
psicotropo Lógico Medicamento psicotropo
estupefaciente Lógico Medicamento estupefaciente
ema Lógico Indica si el medicamento se ha registrado por
procedimiento centralizado (EMA) o no
docs documento Lista de documentos asociados al medicamento
[]
notas Lógico Indica si existen notas asociadas al medicamento
atc Atc[] Códigos ATC
viasAdministracion Vías[] Vías de administración
Item (Maestras)
Atributos
Nombre Tipo Descripción
Id Entero Identificador numérico del elemento
codigo Texto Identificador alfanumérico del elemento
nombre Texto Nombre del elemento
Registro de cambios
Nombre Tipo Descripción
nregistro Texto Nº de registro del medicamento
fecha Date Fecha en la que se ha producido el cambio
tipoCambio Entero 1: Nuevo
2: Baja
3: Modificado
cambios Texto[] Lista con cadenas de texto que identifican los cambios que
se han producido:
• "estado": estado de autorización
• "comerc": estado de comercialización
• "prosp": prospecto
Agencia Española de Medicamentos y Productos Sanitarios 6
CIMAVet REST API v1.4
Nombre Tipo Descripción
• "ft": ficha técnica
• "otros": cualquier otro tipo de cambio
Por ejemplo:
["estado", "ft"]
Recursos
Parámetros comunes
Todos los métodos que devuelven los resultados paginados permiten un parámetro llamado
"pagina" que indica la página de datos a mostrar.
GET medicamentos?{condiciones}
Devuelve una lista de medicamentos basándose en las condiciones introducidas
Parámetros
Nombre Descripción
nombre Nombre del medicamento
laboratorio Nombre del laboratorio
practiv1 Nombre del principio activo
practiv2 Nombre del principio activo
idpractiv1 ID del principio activo
idpractiv2 ID del principio activo
cn Código nacional
atc Código ATC o descripción
nregistro Nº de registro
nregistrobusq Nº de registro para búsquedas con comodines y sin tener en
cuenta espacios
excipiente Nombre del excipiente
idExcipiente ID del excipiente
especie Nombre de la especie destino
idEspecie ID de la especie destino
comerc 1 – Comercializados, 0 – No comercializado, Vacio - Todos
sitadm 1 – Autorizado, 2 – Suspendidos, 3 - Anulados, Vacio – Todos
idVia ID de la vía de administración
via Nombre de la vía de administración
IdForma ID forma farmacéutica
forma Nombre de la forma farmacéutica
tipoMed 1 – Farmacológico, 2 – Inmunológico, 3 – Mixto, 4 –
Homeopáticos, Vacio – Todos
administracion 1 – Solo por Veterinario, 2 – Control veterinario, Vacio – Todos
estupefaciente 1 – Estupefaciente, 0 – No estupefaciente, Vacio – Todos
psicotropo 1 – Psicótropo, 0 – No psicótropo, vacio – Todos
dispensacion 1 – Sujeto a prescripción, 2 – No sujeto a prescripción, Vacio –
Todos
Agencia Española de Medicamentos y Productos Sanitarios 7
CIMAVet REST API v1.4
GET medicamento?{condiciones}
Devuelve una lista de medicamentos basándose en las condiciones introducidas
Parámetros
Nombre Descripción
cn Código nacional
nregistro Nº de registro
GET presentaciones?{condiciones}
Devuelve una lista de presentaciones basándose en las condiciones introducidas
Parámetros
Nombre Descripción
cn Código nacional
nregistro Nº de registro
comerc S – Comercializados, vacio - Todos
GET presentacion/{cn}
Devuelve una lista de presentaciones basándose en las condiciones introducidas
Parámetros
Nombre Descripción
cn Código nacional
Agencia Española de Medicamentos y Productos Sanitarios 8
CIMAVet REST API v1.4
GET maestras?{condiciones}
Devuelve una lista de elementos (maestras) basándose en las condiciones introducidas
Parámetros
Nombre Descripción
maestra ID de la maestra a devolver
• 1: Principios activos
• 2: Formas farmacéuticas
• 3: Vías de administración
• 4: Laboratorios
• 5: Códigos ATC
• 6: Excipientes
• 7: Especies destino
• 8: Medicamentos
• 9: Interacciones
• 10: Contraindicaciones
• 11: Indicaciones
• 12: Reacciones adversas
nombre Nombre del elemento a recuperar
Id ID del elemento a recuperar
codigo Código del elemento a recuperar
GET/POST registroCambios?{condiciones}
Devuelve una lista de elementos (medicamentos modificados) basándose en las condiciones
introducidas
Parámetros
Nombre Descripción
fecha Fecha a partir de la cual se desea conocer qué medicamentos se
han dado de alta, de baja o se han modificado. La fecha se
introducirá en formato "dd/mm/yyyy"
nregistro Limitar la búsqueda a este medicamento. Para incluir más de un
medicamento se debe repetir este parámetro tantas veces como
medicamentos se quieran incluir en la consulta
Agencia Española de Medicamentos y Productos Sanitarios 9
