Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-246175132.0 KB
Patients

Create Query

post/api/v2/patients/{particle_patient_id}/query

Path parameters

particle_patient_idstring required

Particle Patient ID

Request body

hintsstring[]

Postal codes hinting at the believed location of records.

purpose_of_usestring required

The purpose of use for which this request is being made.

specialtiesstring[]

The list of specialty searches requested for this patient

Example request

{
  "hints": [
    "11111",
    "22222",
    "33333"
  ],
  "purpose_of_use": "TREATMENT",
  "specialties": [
    "CKD",
    "DIABETES",
    "RENAL",
    "ONCOLOGY",
    "ORTHOPEDICS",
    "CARDIOLOGY",
    "PULMONOLOGY",
    "GASTROENTEROLOGY"
  ]
}

Response

OK

external_patient_idstring

The external patient id of the patient.

hintsstring[]

Postal codes hinting at the believed location of records.

particle_patient_idstring

The particle patient id that corresponds to the patient that the query is meant to be run against.

purpose_of_usestring

The purpose of use for which this request is being made.

query_idstring

The unique ID of the query that was initiated.

specialtiesstring[]

The list of specialty searches requested for this patient

Example response

{
  "external_patient_id": "123456",
  "hints": [
    "11111"
  ],
  "particle_patient_id": "ac82d365-97f9-4111-92fa-3a2b92744b12",
  "purpose_of_use": "TREATMENT",
  "query_id": "5f3ddefa-30b1-412d-a011-9386b48608cc",
  "specialties": [
    "ONCOLOGY"
  ]
}