API ReferenceUnderstand Coverage

Get the active pathway for a member location

View as MarkdownOpen in Claude
Resolves the currently-active pathway for a member’s location. Supply either coordinates (latitude + longitude) or a postcode; the server normalises the postcode and reverses the boundary lookup to find the operating organisation. Returns the published pathway, the operating organisation identifier, and the boundary centroid the request resolved to. Supports cache validation: pass the client’s cached versionId; when the server pathway matches, the response is 304 Not Modified with no body so the client can keep using its cached copy. Returns 404 when the location is outside any served jurisdiction.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

latitudedoubleOptional-90-90

Latitude (WGS84). Combine with longitude to resolve the active pathway by location. Both coordinates are required together; the postcode path is mutually exclusive.

longitudedoubleOptional-180-180

Longitude (WGS84). See latitude.

postcodestringOptional<=10 characters

Full postcode for the location. Server-normalised (spaces stripped, uppercased). Used when coordinates are not provided.

versionIddoubleOptional>=1

Client’s cached pathway versionId. When supplied and matching the server version, the response is 304 Not Modified with no body. Use this for efficient caching.

Response

The active pathway and its resolution metadata.
planDefinitionIdstring
Stable identifier of the resolved active pathway.
versionIddouble

Monotonically-increasing version number of the resolved pathway.

organizationIdstring
Stable identifier of the operating organisation that owns the pathway.
resourcemap from strings to any

The FHIR R4 PlanDefinition resource as published, with the decision-tree extension flattened to the request locale.

publishedAtstring
ISO 8601 timestamp at which the pathway was published.
centroidLatitudedouble

Latitude of the boundary centroid the request resolved to (WGS84).

centroidLongitudedouble

Longitude of the boundary centroid the request resolved to (WGS84).