# Health Canada DPD DIN Portfolio Status Event Monitor (`plym-actor-factory/ca-hc-dpd-din-portfolio-status-monitor`) Actor

Watch Drug Identification Numbers (DIN) and emit typed Marketed/Cancelled/Dormant/Approved/company events from the official Health Canada Drug Product Database (DPD) API. Not a flat DPD dump; not recalls; not openFDA; not unpaid formulary SaaS.

- **URL**: https://apify.com/plym-actor-factory/ca-hc-dpd-din-portfolio-status-monitor.md
- **Developed by:** [Daniel Witney](https://apify.com/plym-actor-factory) (community)
- **Categories:** AI, Automation, Business
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $20.00 / 1,000 dpd din status event delivereds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Health Canada DPD DIN Portfolio Status Event Monitor

Watch a book of **Drug Identification Numbers (DIN)** and emit typed status/company events when the official **Health Canada Drug Product Database (DPD) API** shows a DIN becoming **Marketed**, moving to **Cancelled\*** / **Dormant** / **Approved**, or changing **company**.

**Not** a flat nationwide DPD dump billed as rows. **Not** a Health Canada recalls ticker. **Not** an openFDA clone. **Not** unpaid formulary SaaS scrape.

### DIN ↔ drug\_code join (honest)

DPD separates product identity from status history:

1. `GET https://health-products.canada.ca/api/drug/drugproduct/?din={DIN}` → `drug_code`, brand, company, `last_update_date`
2. `GET https://health-products.canada.ca/api/drug/status/?id={drug_code}` → faithful **`status`** + `history_date` / `original_market_date`

This Actor always joins those two endpoints for each watched DIN. Status strings are **faithful to DPD** (e.g. `Cancelled Post Market`, `Cancelled Pre Market`, `Cancelled (Unreturned Annual)` — not collapsed away). Typed PPE event names map new status → `DPD_DIN_MARKETED` / `DPD_DIN_CANCELLED` / `DPD_DIN_DORMANT` / `DPD_DIN_APPROVED` (other rare statuses → `DPD_DIN_STATUS_CHANGED`); the raw DPD string is retained on `event_subtype` / `status`.

Optional bulk extract files exist for bootstrap of very large books; live portfolio mode uses per-DIN API lookups only.

### Coverage honesty

- Public DPD API only — not a private formulary case file; not recalls; not openFDA (US).
- Cadence = scheduled snapshot poll (not streaming).
- Absence from DPD ≠ proof of every possible market-authorization state outside published DPD.
- First observation of a DIN stores a **baseline only** (no product charge).

### Events

| Event | When |
|-------|------|
| `DPD_DIN_MARKETED` | New / changed status is `Marketed` |
| `DPD_DIN_CANCELLED` | New status starts with `Cancelled` (faithful subtype retained) |
| `DPD_DIN_DORMANT` | New status is `Dormant` |
| `DPD_DIN_APPROVED` | New status is `Approved` |
| `DPD_DIN_STATUS_CHANGED` | Other status flips (e.g. Restricted Access) or drop from API |
| `DPD_COMPANY_CHANGED` | `company_name` fingerprint changed |
| `RUN_STATUS` | Non-billable health row every successful run |

### Modes

- **`sourceMode=fixture`** (default): Store health / CI. With `emitFixtureDemoEvents=false` (default) emits **only** `RUN_STATUS` / `FIXTURE_HEALTH` → **0** product charges.
- **`sourceMode=live`**: Official Health Canada DPD API (**no API key**). Portfolio-safe — does **not** download the national extract by default.

### Pricing (Model A)

- `dpd-din-status-event-delivered` @ **$0.02** / unique delivered event
- `apify-actor-start` @ **$0.00005**
- Quiet books ≈ $0 product charge

### Input

See `.actor/input_schema.json`. Primary field: `dins` (1–8 digits; normalized to 8-digit zero-padded). Optional `signalGroups`: `status`, `company`.

### Legal

**GREEN** — Health Canada DPD public API / Open Government Licence — Canada. Cite Health Canada + retrieval date. Default product fields = DIN + drug\_code + brand + company + status (product/org data).

### A1b wedge

DIN watchlist × scheduled official DPD API status snapshot diff → typed status/company events only for the book. Existing Store shelf is a flat DPD dump @1 MAU + recalls scrapers (wrong job). See `opportunity/reports/phase3-a1b-next3-v12.md`.

# Actor input Schema

## `dins` (type: `array`):

Drug Identification Numbers (1–8 digits; normalized to 8-digit zero-padded) to monitor against the official Health Canada DPD API. Invalid entries are skipped with no charge. Not a nationwide dump — only DINs on the book are evaluated. Actor joins each DIN to drug\_code via drugproduct/?din= then fetches status/?id={drug\_code}.

## `signalGroups` (type: `array`):

Which change groups to evaluate: status (Marketed/Cancelled/Dormant/Approved/other faithful DPD status flips), company (company\_name changes). Default: both.

## `maxRunSeconds` (type: `integer`):

Wall-clock budget for the run (API queries + watchlist diff).

## `maxEvents` (type: `integer`):

Stop after this many unique change events are delivered (does not include RUN\_STATUS).

## `resumeFromCheckpoint` (type: `boolean`):

If true, resume DIN snapshots and seen event\_uids from the default Key-Value Store.

## `sourceMode` (type: `string`):

fixture = local/CI / Apify Store daily auto-test default (no network; emits RUN\_STATUS only unless emitFixtureDemoEvents=true). live = official Health Canada DPD API (no API key). Not recalls scrape; not flat DPD dump; not openFDA; not unpaid formulary SaaS.

## `emitFixtureDemoEvents` (type: `boolean`):

When sourceMode=fixture, if true push fabricated change events from local fixtures (unit/local demos only). Default false so Store daily auto-tests never emit fake DPD events or charge dpd-din-status-event-delivered. Production: leave false and use sourceMode=live. SAMPLE rows only: demo events use placeholder entities (never real companies/IDs), are flagged sample=true / isSample=true, and are NEVER charged.

## `asOfHint` (type: `string`):

Optional as\_of label for events / RUN\_STATUS. Defaults to status history\_date / product last\_update\_date from DPD.

## `maxTotalChargeUsd` (type: `number`):

Optional soft budget hint for delivered change events. Platform ACTOR\_MAX\_TOTAL\_CHARGE\_USD also applies when set.

## `drugProductApiUrl` (type: `string`):

Optional override for the official DPD drugproduct endpoint. Default: https://health-products.canada.ca/api/drug/drugproduct/

## `statusApiUrl` (type: `string`):

Optional override for the official DPD status endpoint. Default: https://health-products.canada.ca/api/drug/status/

## Actor input object example

```json
{
  "dins": [
    "00435430",
    "00364835",
    "02223155",
    "00000809"
  ],
  "signalGroups": [
    "status",
    "company"
  ],
  "maxRunSeconds": 55,
  "maxEvents": 500,
  "resumeFromCheckpoint": true,
  "sourceMode": "fixture",
  "emitFixtureDemoEvents": false
}
```

# Actor output Schema

## `OUTPUT` (type: `string`):

JSON summary: delivered, charged, runStatus, checkpoint, stats, DPD coverage limits

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("plym-actor-factory/ca-hc-dpd-din-portfolio-status-monitor").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("plym-actor-factory/ca-hc-dpd-din-portfolio-status-monitor").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call plym-actor-factory/ca-hc-dpd-din-portfolio-status-monitor --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,plym-actor-factory/ca-hc-dpd-din-portfolio-status-monitor"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/oNNMdllnhqWhaJW8L/builds/gXMaESjqXxjAkv8md/openapi.json