Submit a PREM response

View as MarkdownOpen in Claude
Records Patient-Reported Experience Measure (PREM) feedback after a navigation session. Captured anonymously: only the navigation session, rating, optional free text, and optional provider/outcome context are stored. Submitting a rating that mismatches the linked session’s recorded outcome is accepted but warn-logged for analytics review. Idempotent on (navigationSessionId, anonymousUid): repeated submissions for the same session by the same client update the same row.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
navigationSessionIdstringRequired

Identifier of the navigation session this feedback is for. Accepts the snake_case key navigation_session_id.

q1RatingdoubleRequired1-5

Member satisfaction rating from 1 (very dissatisfied) to 5 (very satisfied). Accepts the snake_case key q1_rating.

q2FreeTextstringOptional

Free-text feedback about the experience. Accepts the snake_case key q2_free_text.

q3ConditionalTextstringOptional

Conditional follow-up text (only shown to members whose rating triggered the follow-up question). Accepts the snake_case key q3_conditional_text.

providerIdstringOptional

Identifier of the provider the member visited, when known. Accepts the snake_case key provider_id.

outcomeCodestringOptional

Outcome code of the session being rated. Accepts the snake_case key outcome_code.

Response

The recorded PREM response.
dataobject
messagestring

Human-readable acknowledgement.