POST v1/organization/authenticatedaccess

Get Authenticated Access URL: Request a URL that provides authenticated access to a specific area of EMR-Link

Request Information

URI Parameters

None.

Body Parameters

AuthenticatedAccess
NameDescriptionTypeAdditional information
UserName

Username in EMR-Link for which to provide authenticated access.

string

Max length: 255
UserLastName

User's Last Name. Can be used when user is a Medical Professional for signing authorization in some workflows.

string

Max length: 255
UserFirstName

User's First Name. Can be used when user is a Medical Professional for signing authorization in some workflows.

string

Max length: 255
UserNPI

User's NPI. Can be used when user is a Medical Professional for signing authorization in some workflows.

string

Max length: 255
AutoSignEnabled

Indicates Auto Signing workflow is enabled.

boolean

None.
Action

The action to take once authenticated. The recognized actions are:

  • userhome: Open on user home page. (Default action if no action provided).
  • openorder: Open order identified by the EMRLinkOrderID below. To be used when order does not belong to a patient chart.
  • openchartorder: Open order identified by the EMRLinkOrderID below. To be used when order belongs to a patient chart.
  • openchartorders: Open the patient chart identified by the Patient demographics provided below (Last Name, First Name, DOB, SSN (optional), and Location of Care information) and show the patient's orders list.
  • openchartresults: Open the patient chart identified by the Patient demographics provided below (Last Name, First Name, DOB, SSN (optional), and Location of Care information) and show the patient's results list.
  • manifestreport: Open on the manifest report page within EMR-Link.
  • ordermap: Open on the Order Map page within EMR-Link.
Note that the openchartorders and openchartresults actions require patient charts to be created in EMR-Link via an ADT feed or via the Create or Initiate order API calls with the proper organization settings enabled.

string

Max length: 25
EMRLinkOrderID

Order ID generated by EMR-Link. For use when the action involves a specific order.

string

Max length: 10
PatientID

Patient ID to be used when accessing a patient chart.

string

Max length: 255
PatientLastName

Patient Last Name to be used when accessing a patient chart.

string

Max length: 255
PatientFirstName

Patient First Name to be used when accessing a patient chart.

string

Max length: 255
PatientDOB

Patient Date of Birth to be used when accessing a patient chart.

string

Max length: 12
PatientSSN

Patient SSN to be used when accessing a patient chart.

string

Max length: 11
Location

Location of Care name to be used when accessing a patient chart.

string

Max length: 255
LocationAbbreviation

The abbreviation of the Location of Care.

string

Max length: 255
DefaultServiceProviderName

If provided, this will override the default service provider set in the New Order section of the patient chart. Typically the default service provider is set either by Location of Care or by Insurance contract.

string

Max length: 255
InitialOrderMapServiceProviderName

If the Action is 'ordermap', this will set the initial order map selection to this service provider. If not provided, the order map for the first service provider in the list will be selected.

string

Max length: 255
HideCloseButton

If true, and the Action is 'openorder', the Close button will be hidden.

boolean

None.
HideUserMenu

If true, the user context menu will be hidden.

boolean

None.
HideAllTabs

If true, all tabs in the user interface will be hidden thus hiding access to areas of the application not targeted by the action specified.

boolean

None.
HideChartActions

If true, the Find Patient, New Patient, and Merge Patient actions are not shown in the Patient Chart page.

boolean

None.
RestrictedRights

If supplied, the user will be limited to the access rights provided regardless of the user's current account settings.

Collection of UserRights

None.

Request Formats

application/json, text/json

Sample: 
{
  "UserName": "sample string 1",
  "UserLastName": "sample string 2",
  "UserFirstName": "sample string 3",
  "UserNPI": "sample string 4",
  "AutoSignEnabled": true,
  "Action": "sample string 6",
  "EMRLinkOrderID": "sample string 7",
  "PatientID": "sample string 8",
  "PatientLastName": "sample string 9",
  "PatientFirstName": "sample string 10",
  "PatientDOB": "sample string 11",
  "PatientSSN": "sample string 12",
  "Location": "sample string 13",
  "LocationAbbreviation": "sample string 14",
  "DefaultServiceProviderName": "sample string 15",
  "InitialOrderMapServiceProviderName": "sample string 16",
  "HideCloseButton": true,
  "HideUserMenu": true,
  "HideAllTabs": true,
  "HideChartActions": true,
  "RestrictedRights": [
    0,
    0
  ]
}

application/xml, text/xml

Sample: 
<AuthenticatedAccess xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <UserName>sample string 1</UserName>
  <UserLastName>sample string 2</UserLastName>
  <UserFirstName>sample string 3</UserFirstName>
  <UserNPI>sample string 4</UserNPI>
  <AutoSignEnabled>true</AutoSignEnabled>
  <Action>sample string 6</Action>
  <EMRLinkOrderID>sample string 7</EMRLinkOrderID>
  <PatientID>sample string 8</PatientID>
  <PatientLastName>sample string 9</PatientLastName>
  <PatientFirstName>sample string 10</PatientFirstName>
  <PatientDOB>sample string 11</PatientDOB>
  <PatientSSN>sample string 12</PatientSSN>
  <Location>sample string 13</Location>
  <LocationAbbreviation>sample string 14</LocationAbbreviation>
  <DefaultServiceProviderName>sample string 15</DefaultServiceProviderName>
  <InitialOrderMapServiceProviderName>sample string 16</InitialOrderMapServiceProviderName>
  <HideCloseButton>true</HideCloseButton>
  <HideUserMenu>true</HideUserMenu>
  <HideAllTabs>true</HideAllTabs>
  <HideChartActions>true</HideChartActions>
  <RestrictedRights>
    <UserRights>MANAGE_USERS</UserRights>
    <UserRights>MANAGE_USERS</UserRights>
  </RestrictedRights>
</AuthenticatedAccess>

Response Information

Resource Description

AuthenticatedAccessResponse
NameDescriptionTypeAdditional information
AccessURL

Time sensitive URL for accessing EMR-Link web application as an authenticated user

string

None.
Error

Will be set to True if any errors occur during the processing of the API method.

boolean

None.
ErrorMessage

Will contain an error message string if Error is True.

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "AccessURL": "sample string 1",
  "Error": true,
  "ErrorMessage": "sample string 3"
}

application/xml, text/xml

Sample: 
<AuthenticatedAccessResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 3</ErrorMessage>
  <AccessURL>sample string 1</AccessURL>
</AuthenticatedAccessResponse>