• popHealth 5.1

Resources

Admin::caches
Caches Admin

Resource	Description
GET /api/admin/caches/count	Return count of caches in the database.
DELETE /api/admin/caches	Empty all caches in the database.

Admin::patients
Patients Admin

Resource	Description
GET /api/admin/patients/count	Get count of patients in the database
POST /api/admin/patients	Upload a zip file of patients.
DELETE /api/admin/patients/deletePatientsFromPractice	Delete all the patients from a practice (practice_id)
DELETE /api/admin/patients	Delete all patients in the database.
PUT /api/patient	Load a single patient XML file into popHealth

Admin::practices
Practices

Resource	Description
GET /api/practices/:id	Get the practice information
GET /api/practices	Get all practice information
POST /api/practices	Create a practice
GET /api/practices/search?tin=:tin&address=:address	Search for practice by a full or partial TIN

Admin::providers
Providers Admin

Resource	Description
GET /api/admin/providers/count	Get count of providers in the database
POST /api/admin/providers	Upload an opml file of providers.
DELETE /api/admin/providers	Delete all providers in the database.

Admin::users
Users Admin

Resource	Description
GET /api/admin/users	Get a list of users.
POST /api/admin/users/:id/promote	Promote a user to provided role.
POST /api/admin/users/:id/demote	Demote a user from provided role.
GET /api/admin/users/:id/enable	Enable a users account.
GET /api/admin/users/:id/disable	Disable a users account.
GET /api/admin/users/:id/approve	Approve a users account.
POST /api/admin/users/:id/update_npi	Update users associated NPI.

Measure baselines
Measure Baselines

Resource	Description
GET /api/measure_baselines/:id	Get a clinical quality measure baseline

Measures
Measures

Resource	Description
GET /api/measures	Get a list of measures
GET /api/measures/:id	Get an individual clinical quality measure
POST /api/measures	Load a measure into popHealth
DELETE /api/measures/:id	Remove a clinical quality measure from popHealth

Patients
Patients

Resource	Description
GET /api/patients	Get a list of patients
GET /api/patients/:id[?include_results=:include_results]	Retrieve an individual patient
POST /api/patients	Load a patient into popHealth
DELETE /api/records/:id	Remove a patient from popHealth
GET /api/patients/:id/results	Retrieve the CQM calculation results for a individual patient

Providers
Providers

Resource	Description
GET /api/providers	Get a list of providers. Returns all providers that the user has access to.
GET /api/providers/:id	Get an individual provider
POST /api/providers	Create a new provider
PUT /api/providers/:id	Update a provider
DELETE /api/providers/:id	Remove an individual provider
GET /api/providers/search?npi=:npi&tin=:tin&address=:address	Search for provider by partial NPI/TIN/Addresss

Queries
Queries

Resource	Description
GET /api/queries/:id	Retrieve clinical quality measure calculation
POST /api/queries	Start a clinical quality measure calculation
DELETE /api/queries/:id	Remove clinical quality measure calculation
PUT /api/queries/:id/recalculate	Force a clinical quality measure to recalculate
POST /api/queries/:id/filter	Apply a filter to an existing measure calculation
POST /api/queries/:id/clearfilters	Clear all filters and recalculate
GET /api/queries/:id/patient_results[?population=true|false]	Retrieve patients relevant to a clinical quality measure calculation

Reports
Reports

Resource	Description
GET /api/reports/*qrda_cat3.xml	Retrieve a QRDA Category III document
GET /api/reports/*cat1.zip	Retrieve a QRDA Category I document
GET /api/reports/patients
GET /api/reports/team_report	Retrieve a QRDA Category III document
GET /api/reports/measures_spreadsheet	Retrieve a spreadsheet of measure calculations
GET /api/reports/cat1/:id/:measure_ids

Teams
Teams

Resource	Description
GET /api/teams
GET /api/teams/:id
GET /api/teams/team_providers/:id

Value sets

Resource	Description
GET /api/value_sets/:oid?search=:search