Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-246175132.0 KB
Patients

Get FHIR Resources By Type

Returns a paged FHIR Bundle containing resources of the specified type for the patient. Use _count to control page size. When more pages exist, the response Bundle includes a link with rel=next whose URL contains a _page_token — pass that token to retrieve the next page. A link with rel=previous is also included when not on the first page.

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

Path parameters

particle_patient_idstring required

Particle Patient ID

type'AllergyIntolerance' | 'Appointment' | 'CarePlan' | 'Composition' | 'Condition' | 'Coverage' | 'DiagnosticReport' | 'DocumentReference' | 'Encounter' | 'FamilyMemberHistory' | 'Immunization' | 'Location' | 'Medication' | 'MedicationRequest' | 'MedicationStatement' | 'Observation' | 'Organization' | 'Patient' | 'Practitioner' | 'PractitionerRole' | 'Procedure' | 'Provenance' | 'RelatedPerson' | 'Specimen' required

FHIR resource type. Valid values: AllergyIntolerance, Appointment, CarePlan, Composition, Condition, Coverage, DiagnosticReport, DocumentReference, Encounter, FamilyMemberHistory, Immunization, Location, Medication, MedicationRequest, MedicationStatement, Observation, Organization, Patient, Practitioner, PractitionerRole, Procedure, Provenance, RelatedPerson, Specimen.

Query parameters

_countinteger

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

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

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