IPS Data Sources

Overview

The IPS data sources module manages literature references from scientific databases. It supports bulk import, deduplication, and automatic KPI calculation for tracking literature coverage.

Supported Sources

PMC - PubMed Central
LILACS - Latin American and Caribbean Health Sciences Literature
SCIELO-WEB - Scientific Electronic Library Online
OTRA - Other sources

List Literature Sources

GET /api/v1/ips/123/fuentes
Authorization: Bearer <token>

Path Parameters

report_id

integer

required

IPS report ID

Response

Returns an array of literature sources sorted by year (descending) and title:

Response Example

[
  {
    "id": 1001,
    "source": "PMC",
    "title": "Safety profile of paracetamol in pediatric patients",
    "citation": "Smith J, et al. (2024). Safety profile of paracetamol in pediatric patients. J Pharmacovigilance. doi: 10.1234/jpv.2024.001",
    "url": "https://pubmed.ncbi.nlm.nih.gov/12345678",
    "year": 2024,
    "journal": "Journal of Pharmacovigilance",
    "abstract": "This study evaluates the safety profile of paracetamol...",
    "detected_total": 1,
    "created_at": "2024-03-15T10:30:00Z"
  },
  {
    "id": 1002,
    "source": "LILACS",
    "title": "Reacciones adversas al paracetamol en América Latina",
    "citation": "García M, et al. (2023). Reacciones adversas al paracetamol en América Latina. Rev Farmacol.",
    "url": "https://lilacs.bvsalud.org/resource/123",
    "year": 2023,
    "journal": "Revista de Farmacología",
    "abstract": "Estudio retrospectivo de reacciones adversas...",
    "detected_total": 3,
    "created_at": "2024-03-15T10:35:00Z"
  }
]

integer

Source record ID

source

string

Database source: PMC, LILACS, SCIELO-WEB, or OTRA

title

string

Article title

citation

string

Full bibliographic citation

url

string

Article URL

year

integer

Publication year

journal

string

Journal name

abstract

string

Article abstract or summary

detected_total

integer

Number of times this article was detected in searches

Save Literature Sources (Bulk)

Save multiple literature references with optional server-side translation.

POST /api/v1/ips/123/fuentes/bulk
Authorization: Bearer <token>
Content-Type: application/json

{
  "items": [
    {
      "title": "Safety profile of paracetamol",
      "collection": "PMC",
      "year": 2024,
      "url": "https://pubmed.ncbi.nlm.nih.gov/12345678",
      "journal": "J Pharmacovigilance",
      "abstract": "This study evaluates safety...",
      "detected_total": 1
    },
    {
      "title": "Adverse reactions to paracetamol",
      "collection": "LILACS",
      "year": 2023,
      "url": "https://lilacs.bvsalud.org/resource/123",
      "detected_total": 3
    }
  ],
  "translate": false,
  "target_lang": "es"
}

Path Parameters

report_id

integer

required

IPS report ID

Request Body

items

array

required

Array of literature items to save

translate

boolean

default:false

Enable server-side translation of titles and abstracts

target_lang

string

default:"es"

Target language code for translation (e.g., “es”, “en”)

Item Schema

Each item in the items array should contain:

title

string

Article title

collection

string

Source database: PMC, LILACS, SCIELO, or other

source

string

Alternative to collection - normalized source identifier

url

string

Article URL

year

integer

Publication year (0-9999)

journal

string

Journal name

abstract

string

Article abstract or summary

citation

string

Pre-formatted citation (auto-generated if not provided)

detected_total

integer

default:1

Number of times detected in search results

Response

{
  "saved": 2,
  "kpis": {
    "literaturas_detected": 150,
    "pmc_detected": 80,
    "lilacs_detected": 40,
    "scielo_detected": 30
  },
  "total_now": 152
}

saved

integer

Number of items processed in this request

kpis

object

Updated KPI metrics for literature coverage

total_now

integer

Total number of sources for this report after save

Deduplication

The endpoint automatically deduplicates based on (url, title, year) combinations:

Exact duplicates are skipped
Existing entries are updated if new data is richer (longer citation, has abstract, etc.)
Trash entries (navigation links, T&C pages) are filtered out

Save Literature Sources (Simple)

Compatibility endpoint for simpler bulk save operations.

POST /api/v1/ips/123/fuentes?replace=false
Authorization: Bearer <token>
Content-Type: application/json

[
  {
    "title": "Safety profile of paracetamol",
    "collection": "PMC",
    "year": 2024,
    "url": "https://pubmed.ncbi.nlm.nih.gov/12345678"
  }
]

Path Parameters

report_id

integer

required

IPS report ID

Query Parameters

replace

boolean

default:false

If true, delete all existing sources before inserting new ones

Request Body

Array of source items (same schema as bulk endpoint).

Response

{
  "saved": 1,
  "kpis": {
    "literaturas_detected": 151,
    "pmc_detected": 81,
    "lilacs_detected": 40,
    "scielo_detected": 30
  },
  "total_now": 153
}

Delete All Sources

DELETE /api/v1/ips/123/fuentes
Authorization: Bearer <token>

Path Parameters

ips_id

integer

required

IPS report ID

Response

{
  "deleted": 153
}

Cleanup Citations

Clean and normalize citation formatting for all sources in a report.

POST /api/v1/ips/123/fuentes/cleanup
Authorization: Bearer <token>

Path Parameters

ips_id

integer

required

IPS report ID

Response

{
  "cleaned": 42
}

cleaned

integer

Number of citations cleaned/normalized

What Gets Cleaned

Standardizes author formatting
Normalizes journal abbreviations
Formats DOI links consistently
Removes duplicate whitespace
Standardizes year formatting

KPI Metrics

The system automatically calculates and updates these KPI metrics when sources are saved:

Report-Level KPIs

Stored in the ips_report table:

literaturas_detected - Total literature items detected
pmc_detected - Items from PubMed Central
lilacs_detected - Items from LILACS
scielo_detected - Items from SciELO

Access KPIs

KPIs are automatically updated when saving sources and included in report responses:

{
  "id": 123,
  "producto_id": 456,
  "periodo_inicio": "2024-01-01",
  "periodo_fin": "2024-12-31",
  "kpis": {
    "literaturas_detected": 150,
    "pmc_detected": 80,
    "lilacs_detected": 40,
    "scielo_detected": 30
  }
}

Citation Auto-Generation

If a citation is not provided, the system auto-generates one using available fields: Format: Authors. (Year). Title. Journal. DOI/URL Example:

Smith J, García M. (2024). Safety profile of paracetamol in pediatric patients. Journal of Pharmacovigilance. doi: 10.1234/jpv.2024.001

Field Priority:

Use citation if provided
Use cite or apa field if available
Build from: authors/creators + year + title + journal + doi/url

Source Normalization

Collection names are normalized to standard codes:

Input	Normalized
PMC, PubMed, PubMed Central	`PMC`
LILACS, lilacs	`LILACS`
SCIELO, SciELO, Scielo	`SCIELO-WEB`
Any other value	`OTRA`

Translation Support

When translate: true is set, the backend can automatically translate titles and abstracts:

{
  "items": [
    {
      "title": "Safety profile of paracetamol",
      "abstract": "This study evaluates..."
    }
  ],
  "translate": true,
  "target_lang": "es"
}

Result:

{
  "title": "Perfil de seguridad del paracetamol",
  "abstract": "Este estudio evalúa..."
}

Requirements:

Translation service must be configured at /api/v1/nlp/translate/batch
Uses same authentication token
Timeout: 40 seconds
Falls back to original text if translation fails

Best Practices

Bulk Import

Use /fuentes/bulk for large imports with deduplication
Set replace: false to merge with existing data
Include detected_total to track search result frequencies
Provide DOIs when available for better citation quality

Citation Quality

Include full journal names, not abbreviations
Provide year for proper sorting
Include abstracts for better context
Use DOIs instead of PMIDs when possible

Performance

Batch imports in chunks of 100-500 items
Use translation sparingly (adds 40s overhead)
Run cleanup after bulk imports, not during
Query with pagination for reports with >1000 sources

Authentication

ICSR

IPS Reports

Document Management

Surveillance

OCR & NLP

Products & MedDRA

​Overview

​Supported Sources

​List Literature Sources

​Path Parameters

​Response

​Save Literature Sources (Bulk)

​Path Parameters

​Request Body

​Item Schema

​Response

​Deduplication

​Save Literature Sources (Simple)

​Path Parameters

​Query Parameters

​Request Body

​Response

​Delete All Sources

​Path Parameters

​Response

​Cleanup Citations

​Path Parameters

​Response

​What Gets Cleaned

​KPI Metrics

​Report-Level KPIs

​Access KPIs

​Citation Auto-Generation

​Source Normalization

​Translation Support

​Best Practices

​Bulk Import

​Citation Quality

​Performance

Build docs developers (and LLMs) love

Overview

Supported Sources

List Literature Sources

Path Parameters

Response

Save Literature Sources (Bulk)

Path Parameters

Request Body

Item Schema

Response

Deduplication

Save Literature Sources (Simple)

Path Parameters

Query Parameters

Request Body

Response

Delete All Sources

Path Parameters

Response

Cleanup Citations

Path Parameters

Response

What Gets Cleaned

KPI Metrics

Report-Level KPIs

Access KPIs

Citation Auto-Generation

Source Normalization

Translation Support

Best Practices

Bulk Import

Citation Quality

Performance