v1

latestOpenAPI 3.0.0Apache 2.02026-07-246175132.0 KB
Patients

Get FHIR Datasets

Returns a FHIR Bundle with all clinical resources for the patient — equivalent to a FHIR $everything call. No need to append $everything to the URL. Use _since to retrieve only data gathered after a specific timestamp, and _count with _page_token to page through results. To retrieve resources of a specific type, use GET /fhir/{type} instead.

get/api/v2/patients/{particle_patient_id}/fhir

Path parameters

particle_patient_idstring required

Particle Patient ID

Query parameters

_page_tokenstring

Opaque token for the next or previous page of results. Obtain from link[rel=next]._page_token or link[rel=previous]._page_token in the Bundle response.

_countinteger

Maximum number of resources to return per page. When omitted, the server uses a default page size.

_sincestring

Return only resources updated after this timestamp (ISO 8601 / RFC3339). Based on when Particle last queried the network, not clinical documentation dates.

Response

OK

resourceTypestring

The type of the FHIR resource.

totalinteger

The total number of resources in the bundle.

typestring

The type of bundle.

Example response

{
  "entry": [
    {
      "fullUrl": "/Patient/1234",
      "search": {
        "mode": "match"
      }
    }
  ],
  "link": [
    {
      "relation": "next"
    }
  ],
  "resourceType": "Bundle",
  "total": 12,
  "type": "searchset"
}