v1

latestOpenAPI 3.0.0Apache 2.02026-07-246175132.0 KB
Queries

List Queries

get/api/v1/queries/

Response

OK

expected_completion_timestring
idstring required
particle_patient_idstring
start_timestring
statestring required

Example response

[
  {
    "demographics": {
      "address_city": "Brooklyn",
      "address_lines": [
        "999 Dev Drive"
      ],
      "address_state": "New York",
      "date_of_birth": "1954-12-01",
      "email": "john@doe.com",
      "encounter_date": "2022-01-20",
      "encounter_type": "AMBULATORY",
      "family_name": "Quark",
      "gender": "MALE",
      "given_name": "Kam",
      "hints": [
        "11111"
      ],
      "npi": "9876543210",
      "postal_code": "11111",
      "purpose_of_use": "TREATMENT",
      "specialties": [
        "ONCOLOGY"
      ],
      "ssn": "123-45-6789",
      "telephone": "234-567-8910"
    },
    "expected_completion_time": "2020-01-01T00:00:00Z",
    "files": [
      {
        "authenticator": "Jane Doe MD",
        "author_name": "John Doe",
        "author_organization": "Particle Health",
        "class_code": "72170-4",
        "confidentiality_code": "N",
        "creation_time": "2020-01-01T00:00:00Z",
        "event_code": "AMB",
        "file_size": 2454,
        "file_source": "CAREQUALITY",
        "format_code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
        "healthcare_facility_type_code": "35971002",
        "id": "ac53cf7c-77ff-434f-8aa3-5966bc5c10ae",
        "language_code": "en-US",
        "practice_setting_code": "132",
        "service_start_time": "2020-01-01T00:00:00Z",
        "service_stop_time": "2020-01-01T00:00:00Z",
        "status_code": "current",
        "title": "Medical Summary",
        "type": "application/xml",
        "type_code": "34133-9",
        "url": "/api/v1/files/4bcd32df-a013-432f-a56a-c8a8705f6653/ac53cf7c-77ff-434f-8aa3-5966bc5c10ae"
      }
    ],
    "id": "4bcd32df-a013-432f-a56a-c8a8705f6653",
    "particle_patient_id": "ea2dc498-9a4c-4937-b6ce-75fdc49e4830",
    "start_time": "2020-01-01T00:00:00Z",
    "state": "COMPLETE"
  }
]