Building Deep Links in an Authenticated User Experience

  • Created  []
  • Updated  []

Introduction

There are times when you want to make deep links available to members who have authenticated in the member portal. For example, you may want to align search results with specific health-related education campaigns, deliver search results for specific cost estimate searches, or highlight changes to products or provider networks during open enrollment. 

Deep links for authenticated users must be configured using the RelayState parameter in the SAML POST. 

Note: Do not URL encode the domain itself.

If your SSO solution starts the IdP-init SAML flow using a URL similar to the following example,

<https://sso.company.com/saml/init?sp=healthsparq&RelayState=>

then you have to URL-encode the RelayState value first. From there, your SSO solution should automatically pass it unencoded in the POST body at the same level as the SAML response.

Note that you can build deep links that include parameters that are different from those passed in the member’s SAML. For example, a deep link to a search for a doctor by speciality could include a ZIP code parameter different from the ZIP code in the member’s SAML attribute data.

Examples

The following examples show the difference between the unencoded (public) and encoded (authenticated) deep link parameter string content. They provide a guide to formulating the encoded deep link string to support the authenticated experience. Use the information available in the Deep Link Parameters Reference and Including Filters in Deep Links sections, along with the examples below to structure your authenticated deep links.

Doctors by Name Search

Unencoded string:

/healthsparq/#/one/auth/search/query=John&radius=25&searchCategory=
PROVIDER_PERSON_NAME

Encoded string:

%2Fhealthsparq%2F%23%2Fone%2Fauth%2Fsearch%2Fquery%3DJohn%26radius%3D25
%26searchCategory%3DPROVIDER_PERSON_NAME

Doctors by Specialty Search

Unencoded string:

/healthsparq/#/one/auth/search/key=Internal%20Medicine&location=Little%20Rock%2C%20AR&
page=1&query=Internal%20Medicine&radius=25&searchCategory=SPECIALTY&searchType=
SYNONYM_PERSON

Encoded string:

%2Fhealthsparq%2F%23%2Fone%2Fauth%2Fsearch%2Fkey%3DInternal%2520Medicine%26location%3
DLittle%2520Rock%252C%2520AR%26page%3D1%26query%3DInternal%2520Medicine%26radius%
3D25%26searchCategory%3DSPECIALTY%26searchType%3DSYNONYM_PERSON

Places by Name Search

Unecoded string:

/healthsparq/#/one/auth/search/location=Little%2520Rock%252C%2520AR&page=1&query=
Childrens%2520Hospital&radius=25&searchCategory=PROVIDER_ORG_NAME

Encoded string:

%2Fhealthsparq%2F%23%2Fone%2Fauth%2Fsearch%2Flocation%3DLittle%252520Rock%25252C%
252520AR%26page%3D1%26query%3DChildrens%252520Hospital%26radius%3D25%26searchCategory
%3DPROVIDER_ORG_NAME

Places by Type Search

Unecoded string:

/healthsparq/#/one/auth/search/key=General%2520Acute%2520Care%2520Hospital&location=
Little%2520Rock%252C%2520AR&page=1&query=General%2520Acute%2520Care%2520Hospital&
radius=25&searchCategory=ORG_SUBTYPE&searchType=SYNONYM_ORGANIZATION

Encoded string:

%2Fhealthsparq%2F%23%2Fone%2Fauth%2Fsearch%2Fkey%3DGeneral%252520Acute%252520Care
%252520Hospital%26location%3DLittle%252520Rock%25252C%252520AR%26page%3D1%26query
%3DGeneral%252520Acute%252520Care%252520Hospital%26radius%3D25%26searchCategory
%3DORG_SUBTYPE%26searchType%3DSYNONYM_ORGANIZATION

Estimate Your Cost Search

Unecoded string:

/healthsparq/#/one/auth/search/key=xray_exam_of_knee_1_or_2&location=
Little Rock, AR&page=1&query=X Ray%2C%20Knee%20%28One%20or%20Two%20Views%29&radius=
100&searchCategory=ENCOUNTER&searchType=ENCOUNTER

Encoded string:

%2Fhealthsparq%2F%23%2Fone%2Fauth%2Fsearch%2Fkey%3Dxray_exam_of_knee_1_or_2%
26location%3DLittle%20Rock%2C%20AR%26page%3D1%26query%3DX-Ray%252C%
2520Knee%2520%2528One%2520or%2520Two%2520Views%2529%26radius%3D100%26searchCategory
%3DENCOUNTER%26searchType%3DENCOUNTER

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request