PAparticlehealth
FHIR

Search for FHIR resources.

Changed on

Searches for FHIR® resources of the given type for one patient. Particle supports the subset of FHIR® search parameters listed below; any other parameter returns a 400.

get/R4/{resource_type}

Request

  • Base URL
    https://sandbox.particlehealth.com
  • URL
    https://sandbox.particlehealth.com/R4/{resource_type}
  • Auth
    API key in header Authorization

Path parameters

resource_typestring required

Resource Type

Query parameters

patientstring required

Patient ID

_countinteger

Maximum number of resources to return per page. Default and maximum 1000; values outside 1-1000 are treated as 1000.

_page_tokenstring

Opaque token for the next page of results. Obtain from the next link in the Bundle response rather than constructing it.

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 _count

    • info

      added the new optional query request parameter _page_token

    • 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