API ReferenceUnderstand Coverage

Get a pathway by identifier

View as MarkdownOpen in Claude

Returns the full pathway row including the FHIR PlanDefinition resource and embedded decision tree (server-flattened to the request locale). Operator-only. Use this endpoint when authoring pathway content or inspecting a specific version. For member runtime, use the active-pathway endpoint.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired
Stable identifier of the pathway.

Response

The pathway row.
idstring
Stable identifier of the pathway.
jurisdictionIdstring
Stable identifier of the jurisdiction the pathway is scoped to.
organizationIdstring
Stable identifier of the operating organisation that owns the pathway.
urlstring
Canonical URL for the pathway.
versionstring
Semantic version assigned by the pathway authors.
namestring

Machine-readable name.

titlestring

Human-readable title.

statusenum
Lifecycle status.
versionIddouble

Monotonically-increasing version number for optimistic locking on draft updates.

lastUpdatedstring
ISO 8601 timestamp of the most recent update.
resourcemap from strings to any

The FHIR R4 PlanDefinition resource as published, including the decision-tree extension nodes flattened to the request locale. Treat as a standard FHIR PlanDefinition; see the FHIR R4 specification for the field-level structure.