PAparticlehealth
Patients

Get FHIR Datasets

Changed on

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 _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

Request

  • Base URL
    https://sandbox.particlehealth.com
  • URL
    https://sandbox.particlehealth.com/api/v2/patients/{particle_patient_id}/fhir
  • Auth
    API key in header Authorization

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. Default and maximum 1000; values outside 1-1000 are treated as 1000.

_typestring

Comma-delimited list of FHIR resource types to include (e.g. Condition,Observation). When omitted, all resource types are returned. Resources are returned grouped by type in alphabetical order, so a single page may contain only one type.

_sincestring

Return only data that Particle created or updated at or after this time, rather than filtering on clinical documentation dates. Accepts a full timestamp with a time zone (e.g. 2024-01-01T00:00:00Z), or lastQuery to return data since the patient's latest completed query; a plain date returns a 400. Each resource's meta.lastUpdated is compared; resources stored before Particle began recording it are always returned until the patient's next query refreshes them.

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"
}

Changes

  • b59a5413a488Revision changes
    • info

      added the new optional query request parameter _type

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status