Patient Provider Map

What is the Patient Provider Map?

The Patient Provider Map API returns the set of healthcare organizations that have clinical records for a given patient across Particle's network. Each entry represents an endpoint organization that has been observed querying or responding on behalf of the patient, enriched with directory information such as NPI, address, and the managing organization (implementer) behind the endpoint.

This is useful for:

  • Understanding which organizations hold records for a patient before or after a query
  • Identifying care relationships and provider footprint across networks
  • Supporting care coordination workflows that need to route to specific facilities

Availability

The Patient Provider Map is not enabled by default. To gain access, reach out to your Particle Health representative and we're happy to get you set up.

Endpoint

GET /api/v2/patients/{particle_patient_id}/provider_map

Returns the provider map for a single patient identified by their Particle Patient ID.

Path Parameters

ParameterTypeRequiredDescription
particle_patient_idstring (UUID)YesThe Particle Patient ID for the patient

Authentication

Requires an API key passed in the Authorization header.

Response

{
  "particle_patient_id": "ac82d365-97f9-4111-92fa-3a2b92744b12",
  "providers": [
    {
      "oid": "2.16.840.1.113883.3.789",
      "organization_name": "Example Regional Medical Center",
      "network": "CAREQUALITY",
      "last_seen": "2025-12-15",
      "active": true,
      "type": "Practice",
      "npi": "1234567890",
      "address": "123 Health Ave",
      "city": "Springfield",
      "state": "IL",
      "postal_code": "62701",
      "lat": "39.799600",
      "lng": "-89.644600",
      "managing_organization_name": "Epic Systems",
      "managing_organization_oid": "2.16.840.1.113883.3.123"
    }
  ]
}

Response Fields

Top-level

FieldTypeDescription
particle_patient_idstringThe Particle Patient ID for the patient
providersarrayList of provider organizations with records for the patient. Empty array if no records are found.

Provider entry fields

FieldTypeRequiredDescription
oidstringYesOrganization Identifier (OID) for the endpoint
organization_namestringYesName of the endpoint organization
networkstringYesNetwork source. Either CAREQUALITY or EHEALTHEXCHANGE
last_seenstringYesMost recent date a record was observed for this patient at this organization, in YYYY-MM-DD format
activebooleanNoWhether the endpoint is currently active in the directory
typestringNoOrganization type (e.g., Practice, Implementer)
npistringNoNational Provider Identifier for the organization
addressstringNoStreet address
citystringNoCity
statestringNoState abbreviation
postal_codestringNoZIP code
latstringNoLatitude coordinate
lngstringNoLongitude coordinate
managing_organization_namestringNoName of the managing (implementing) organization behind the endpoint
managing_organization_oidstringNoOID of the managing organization

Error Responses

StatusDescription
400particle_patient_id is not a valid UUID
401Missing or invalid API key
404Patient not found
500Internal server error

Provider Map Change Notifications

In addition to querying the provider map on demand, you can subscribe to receive webhook notifications when a patient's provider map changes. Two change types are supported:

change_typeDescription
new_providerA new organization OID appeared in the patient's provider map
last_seen_updatedAn existing organization's last_seen date has advanced

To receive these notifications, create a providermap notification via the Management API. See Webhook Event Notifications for payload structure and signature verification.