This resource allows for the management of patient records in the popHealth application. Patient records can be inserted into popHealth in QRDA Category I format through this resource. Additionally, patient information may be retrieved from popHealth. This includes popHealth's internal representation of a patient as well as results for clinical quality measure calculations for a particular patient.

Ids used for patients by this resource are the MongoDB identifier for the patient, not the patient's medical record number.


GET /api/patients
Get a list of patients

Supported Formats

json

Params

Param name Description
page
optional

Validations:

  • Must match regular expression /\d+/.

per_page
optional

Validations:

  • Must match regular expression /\d+/.


GET /api/patients/:id[?include_results=:include_results]
Retrieve an individual patient

Supported Formats

json

Examples

{"_id":"52fbbf34b99cc8a728000068","birthdate":1276869600,"first":"John","gender":"M","last":"Peters","encounters":[{...}], ...}

Params

Param name Description
id
required

Patient ID

Validations:

  • Must be a String

include_results
optional

Include measure calculation results

Validations:

  • Must be a String


POST /api/patients
Load a patient into popHealth

Upload a QRDA Category I document for a patient into popHealth.

Supported Formats

xml

Params

Param name Description
practice_id
optional

ID for the patient's Practice

Validations:

  • Must be a String

practice_name
optional

Name for the patient's Practice

Validations:

  • Must be a String


DELETE /api/records/:id
Remove a patient from popHealth

Params

Param name Description
id
required

The id of the patient

Validations:

  • Must be a String


GET /api/patients/:id/results
Retrieve the CQM calculation results for a individual patient

Supported Formats

json

Examples

[{"DENOM":1.0,"NUMER":1.0,"DENEXCEP":0.0,"DENEX":0.0",measure_id":"40280381-3D61-56A7-013E-6224E2AC25F3","nqf_id":"0038","effective_date":1356998340.0,"measure_title":"Childhood Immunization Status",...},...]

Params

Param name Description
id
required

Patient ID

Validations:

  • Must be a String