Patient Portal Settings

The Patient Portal Settings feature allows the user to view the portal settings for a practice.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Endpoints

Primary

GET

Get patient portal setting
details

Get patient portal setting details

GET

/v1/{practiceid}/misc/portalsettings

Retrieves patient portal settings

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others

Submit

Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid

communicatorbrandid integer The ID of the brand. If provided this will override the value of PORTALDISPLAYNAME in the output structure. If you want the name used in the name used in the portal for non branded portals pass this as undef

Output Parameters

Expand all

communicatorbrandlevelsettings string

patientportalenabled string Boolean to denote whether patient portal is enabled for the practice.

portaldisplayname string Public facing name of the practice.

practicehascommunicatorbrands string Boolean to denote whether the practice has Communicator brands.

smartonfhiridpid string Okta ID of the IDP to use to authenticate users into SMART on FHIR apps

Example Code