Patient Portal Access
The Patient Portal Access feature allows the user to retrieve the patient's portal registration status, portal usage and other portal-related information. For information on portal access, please refer Patient Portal Access workflow.
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 list of users having access to given patient
GET
/v1/{practiceid}/patients/{patientid}/portalaccess
Retrieve a list of portal users associated with a specific patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
communicatorbrandid
integer
The athenaNet Communicator brand ID
Output Parameters
Expand all
accesslevel
string
The level of access that the user has to the patient.
communicatorbrandid
integer
ID of the communicator brand associated with the permission
email
string
Email address of the portal user. This is what they use to login to the patient portal.
name
string
Name of the portal user
relationshiptopatient
string
Describes the relationship of the portal user to the patient.
Example Code
Send invitations to patient portal
POST
/v1/{practiceid}/patients/{patientid}/portalinvitation
Resends the Portal Invitation or Lost Password email
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
success
string
Returns true/false if the operation was successful
Example Code
Get patient's portal status
GET
/v1/{practiceid}/patients/{patientid}/portalstatus
Retrieves the status of portal registration of a specific patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
Output Parameters
Expand all
blockedfailedloginsyn
string
Is this patient blocked from the portal due to failed login attempts.
entitytodisplay
string
Either "FAMILY" or "PATIENT".
familyblockedfailedloginsyn
string
Is this patient's family blocked from the portal due to failed login attempts.
familyregisteredyn
string
Is there a family member registered with access to this patient.
lastlogindate
string
The last login date.
lastloginentity
string
Either "PATIENT" or "FAMILY", the last entity who accessed this patient.
noportalyn
string
The privacy setting for blocking the patient from the portal is set.
portalregistrationdate
string
The date the patient registered for the portal.
registeredyn
string
If this patient is registered or not for the portal.
status
string
The status of the patient. Possible statuses:
REGISTERED: The patient is registered for the portal.
NOTREGISTERED: The patient is not registered for the portal.
FAMILYLOGIN: This patient is set up for a family member to login.
NOPORTAL: The privacy setting for blocking the patient from the portal is set.
BLOCKEDFAILEDLOGINS: The patient is blocked because of failed login attempts.
FAMILYBLOCKEDFAILEDLOGINS: The family member is blocked because of failed login attempts.
termsaccepted
string
Has this patient accepted the portal's Terms and Conditions. This is a good indicator if the patient has actually logged in to the portal or simply is registered without ever having logged in.
Example Code