Unity Sleuth Tutorial - Allscripts Developer Program [HD 1080P]

Unity Sleuth Tutorial - Allscripts Developer Program [Watch in HD 1080P Fullscreen]

This video details the workflow and feature functionality of Unity Sleuth, which is a developer tool designed to jump start ADP partner development within the Allscripts Developer Program. This tool features a code-less way to map out your Unity integration and save your custom integration workflow to file without having to write a single line of code. The goal of this tool is to empower ADP partners by providing a software solution that clearly blueprints their Unity integration, before devoting any development resources to coding up their custom Unity integration. ADP Partners are strongly encouraged to use Unity Sleuth as a troubleshooting/comparison tool while actively developing and testing their own prototype Unity integration code. Please note that this tool is designed to be solely used against the ADP sandboxes which contain no Protected Health Information (PHI). This software will continue to change, so please stay tuned to this video description for links to future tutorial videos for Unity Sleuth.

---

Closed Caption:

hello and welcome to the unity sleuth
tutorial today I'll be talking to you
about unity sleuth and some of its
functionality but to begin let's start
with downloading it from the developer
portal at developer.android.com i'm sure
many of you have already downloaded it
from the developer portal but i want to
go over this just in case someone out
there is not familiar with where to get
it so first i logged in you can signup
and login for free and and create
applications to test the unity API so
i'm logged in over here i'm going to go
over to documentation and down to
downloads so once this page is loaded if
you look at the very top under tools
you'll find unity sleuth so there's a
short description here this video I'm
going to go it's going to be a deeper
dive into the into unity sleuth but go
ahead and click download here and you'll
you'll pull down the unity slip file as
you can see I've already done that so
I'm going to minimize this and show you
where I put it on my desktop
ok here's the zip file so if you're
familiar with this you just right click
extract all and then you will open up
unity sleuth folder
ok and here you're concerned with the
executable so you can just right-click
on it and you can send it to desktop as
a shortcut or if you're like me you can
pin it to your taskbar for easier access
ok you can also just launched it
directly from the folder but that's an
extra step
ok so now we're going to launch unity
sleuth just by clicking this button down
here it may auto update for you and if
that happens it will just launched this
window the splash screen once and then
we'll show an updating screen and then
it will it will launch into this
dashboard takes about a minute at most
to update itself and then long
ok so i'm sure some of you are wondering
you what is unity sleuth and why should
i use it especially if i'm not i'm not i
don't use Windows operating systems
frequently why would i spend up a
virtual machine for this tool
ok so unity sleuth is a detective of the
unity API and it investigates the data
that is returned from the magic actions
magic actions are the unity API calls
and it also provides a way of mapping
out in integration all throughout this
tool there are features that help
improve improve the user experience but
also just explain the unity API to the
developer or to a non technical person
so you'll see that there's tooltips all
throughout if you just hover over
buttons they'll explain what all the
buttons do but what this tool is really
designed for is its to be a guide to
developers that are trying to develop
with the unity API ok so it's also a
codeless way of discovering the API a
lot of API is out there require you to
write code just to discover what the API
can do and this tool solves that problem
its you can download this tool onto a
virtual machine or onto your development
machine and open it you can enter in
your test credentials your unity service
credentials that you got from the
developer portal into this tool and it
will mimic your integrations you can
enter in your credentials you can make
unity calls or magic action calls you
can map out your entire integration with
this tool and you can save it to log and
then you then have all the data
structures that you need to parse the
xml and so you
you've built your integration before
you've written a single line of code so
that's that's why you might want to use
this especially if you're the early
stages of development you can spend more
time planning with this tool than
writing code so it it sort of it
jump-starts your development and your
integration strategy by allowing you to
sort of blueprint and map it out before
writing any code
ok so there's a lot of a lot of buttons
on this dashboard but i think the first
thing i want to start with is sleep
configuration because I think it's
important you understand how these calls
are being made and and how this tool is
sort of abstracted that a little bit ok
so what we're first going to go to is
options sleuth configuration and you can
also hit ctrl s which I'm going to do
which will launch the configuration
alright so as an example I'm going to
pull up professional latest you see
professional latest is a selection over
here on the left-hand side of the
dashboard i'm going to pull it up in
this drop-down professional latest ok
there's a few ways i can use this
drop-down box i can just use it the
traditional way which is what i just did
by selecting it manually my can also
freetype professional latest and then
when there's one selection I hit tab and
autocomplete or i can just start typing
pro and then i can hit the down arrow
keys and hit tab so those are the three
different ways you can use that drop
down for autocomplete okay and also just
regular selection so when i select
professional latest that button over
there on the left-hand side of the
dashboard what it's pulling in are all
of these configured values it's pulling
in this endpoint this patient ID this a
thr provider user account and in the
password associated password and then
finally the unity service credentials
which are the apt name the username and
the password so when I'm a community
calls in this tool it's using these
configuration values so you can change
these you can change patient IDs you
could change usernames and passwords you
can change the service credentials and
this is the the big part of this tool is
that you can change them to that your
test credentials that were given to you
by the developer portal
ok and I'd like to show that to you now
so if we go back to the developer portal
and we go to my login under my
applications i created a some tests
credentials a while back when we first
created the developer portal and what
I'm going to do is I'm going to show you
unity sleuths webservice impersonation
feature or simply known as sleuth
impersonation and that's where i'm
changing these values here in the tool
to the values that are generated by the
developer portal so that these are the
exact same unity service credentials
that you received and you can do the
same thing so we'll just pretend that
these are yours and i'm entering in
yours and it looks like like I've
already entered them but basically i
just copied and pasted these directly in
to sleuth to impersonate the integration
and obviously this is a feature that's
only that is only designed for
developers that are testing against our
adp tests and boxes which do not contain
any ph I this is this feature is not
designed for the field or any production
environment or any ph I system this is
purely to make the development that much
easier for for our AVP partners so they
can get a big head start on development
before they write any code
ok so justjust you keep in mind that
the changing of these values while it's
possible within the this offer to change
this to any endpoint any valid point and
it's really only designed for the ATP
sandboxes because we we want this tool
to be used by developers that are
actively developing against our tests
and boxes ok alright so I've entered in
the my test credentials from the
developer portal and I'm ready to start
impersonating so it okay
right now everything is configured for
me to test the professional latest adp
sandbox endpoint using my test
credentials that i got from the
developer portal and then I'm a new
partner and i want to start testing out
the unity API with this unity detective
or unity sleuth ok so the first call
that i'm going to make you that's
probably the question that a lot of your
asking so how do I know what to do and
what you can do and i'll close this
window in the background when you're not
sure what calls you need to make you go
to help and then you go to developer
portal
ok this goes straight into the api
reference if you're logged in i'm going
to go ahead and sign in and I'll show
you that it goes directly to the API
reference
hmm what I'll try that again
there we go okay yes you have to be
actively logged in and it goes directly
to the API reference and i'm going to
click click on professional EHR because
that's what we're we're working with
right now
so here the list of all the different
API calls sort of based on categories so
if you're interested Emma graphics if
you're injured documents interested in
encounters orders etc etc this is where
you would find that information but i'm
going to do a workflow that i recommend
most of you take a look at it's not
necessarily something that will be
applicable except for the first two
calls that i recommend
get user authentication and get server
info are two calls that i recommend
everyone uses but after that the third
call on the integration and forward it
may not be applicable but it will be a
simple workflow that i'll show you how
this Tool Works ok so the first call
that i recommend everyone uses is get
user authentication and i just did the
ctrl f so i could find the call on this
page right and you can read this
description over here but i'm just going
to jump into the full detail
alright so the API documentation is very
important
it's it's how you use unity sleuth you
use it in conjunction with this
documentation all right now let's look
at the input specification section now
the user ID app name patient ID and
token all of this is already handled by
slu configuration
ok so apt name is already in here and
passed through sleuth patient ID is
already in here and passed the user ID
is already in here and passed so you
don't have to worry about these because
they are pre-configured in sleuth what
you should be worried about
we're not worried about but concerned
about or looking to change are the
parameters so parameters one through six
are what you're going to be paying
attention to when you're making unity
calls and the optionality you have
either required optional or unused
parameters so we're going to focus on
the required parameters for this
workflow you know obviously there's
going to be more feature functionality
and the optional parameters but for this
basic workflow I just want to focus on
you know basic calls with her required
parameters to just to show you how to
use the tool effectively alright so now
to get into the description of this call
it the get user authentication call is
different from the get security token
call that you make
for unity web service credentials
authentication because when you're
calling gets security token for your web
service credentials that's
authenticating that you can use unity
alright it's just saying yes your valid
user of the unity API get user
authentication is different because it's
saying that you're a valid user of that
client chr right so it's another layer
of security and it's authenticating that
this unity web service credential can
access client pays professionally HR so
that's why it's an important call and it
should be the first call in your
integration now what you're looking for
when when what what data you're looking
for from this call is in the output
specification section and what what you
need to pay attention to is the valid
user equals the yes
so that's the data that you're trying to
get out of this call
alright and foremost clients what they
choose to do is they choose to create a
specific EHR user and password for your
integration and so it might be
integration test is the user and
integration test 123 z1 is the password
and that's what you would pass into the
get user authentication call that user
and that password and what you're
looking for in your code is you're
searching for the valid user equals yes
if you get a yes back from the service
then your integration can continue and
proceed if you get a no then you should
return an error message like the the
user could not authenticate something
along those lines
ok so we're going to do an example of
this call now
so selected professional latest i'm
going to start typing get user
authentication and it since it's right
there i'm going to hit the down arrow
key and i'm going to hit
ab ok and for this particular sandbox
i'll hit ctrl s if we go to professional
latest we know that the user name is
Terry and i'm already passing in Terry
automatically with this configuration
the password is going to be manning and
I i do hide that here and the call
requires that I pass it you can see it
right here in two parameter 1
ok so that's what I'm going to do I'm
going to pass Manning in two parameter 1
and like we saw before
what we're looking for is valid user
equals yes so i'm going to go ahead and
hit okay i can click the button click
the call unity now button or it can just
hit okay okay there we go so now we have
a return back let's talk about the
return a little bit at the very top is
the stub and this is what unity sleuth
will will create at the top of every
single unity call for tracking purposes
when you save your log later this will
become very important for backtracking
what calls you've made so just a quick
overview here's the magic action i used
here's the username that I passed in and
again these values are coming from here
ok here's the patient ID i passed in
here is the username my past in here is
the endpoint i passed in right okay and
then the token and the request and
response and that's just coming from the
from the back end code
ok and then here is the parameter that I
used so it attracts the parameters that
I used it doesn't show the ones i don't
okay now you may be wondering well you
know is there an easier way for me to go
through this return because this this
output could be a very large it could be
a very large output and there is i'll
show you the search output button here
you can either click this button or you
can hit ctrl f whichever
control f opens slew search and then it
will allow you to search so if we go
back to the documentation and this will
become second nature to you once you
learn how to read the output
specification but I'm looking for valid
user right that's that's the part the
field name that I'm looking for
so if i go back here and i just type
valid user and i hit enter it will jump
right to it
okay so there we go valid user equals
yes
so what that tells me is that I'm going
to hit enter again
there we go so what that tells me is
that my integration can proceed so
you're going to need some logic in here
that says if yes continue if not
exception
you know generally speaking ok so this
this tells me that my integration can
continue so what I'm going to do next is
I'm going to go down here and i'm going
to go to the get server info call and
this is the second call that I was
telling you about that you might be
interested in using and we're going to
go into that right now
ok we'll go back to the documentation go
to the API reference for professional
EHR and there's get server info at the
top so just like before
here the parameters that I should be
focusing on there all unused ok and this
is the output this is what is returned
from the call
alright and let's say that that i'm
interested in the born on date the unity
born on date for whatever reason just to
just as an example
ok we'll go back here get server info as
you can see none of the parameters have
to be used so I'm just going to make the
call just going to hit OK or call unity
now
all right we have our return so this
call is going to be important for all
integrations for a few reasons at the
biggest reason is the timezone offset so
if your client is in a different time
and then you and your integration it is
relying on that at all then it's
important for you to keep track of that
some integrations may not be relevant
but we require that it we don't we don't
require but we highly recommend that you
use this just you can have this
information within the integration more
importantly it stores the product
versioning so professionally HR it will
tell you the product version that
they're running and it and it also tells
you the unity api version so and that's
known as you AI born on date so that's
another important aspect of this call
its telling you three things the server
time offset the EHR product version and
then finally the unity version so all
three of those things are going to be
important to any integration and so
that's why we recommend that you use
this call it also axis as an echo as
well but it it's it's more or less used
for its versioning and time zone
functionality
ok alright so I've now covered the first
two calls that i recommend everyone uses
now we're going to go off on to a
specific integration strategy that may
not be relevant to what you're doing but
it'll just sort of show you how you use
this tool a little bit a little bit more
oh one thing i want to show you for
those of you that use the chase on the
that we rely on the JSON output of the
JSON endpoints is if you click on json
here and I make the exact same call
again it's going to give you the JSON
formatting so that will be useful for
you that use JSON and you can use it for
all of the calls just by selecting this
i'm going to switch back to the xml just
a preference but that's what that button
is for ok so now let's move on to a
different call i'm going to do a
workflow i'm going to go through a
scenario where I'm a partner and i'm
interested in a page
since let's say demographics I want
their email addresses
okay i want the email addresses that are
stored in there
allscripts EHR ok and then after that
I'm going to be interested in the
patient's allergies and the patient's
medications so let's just say that's my
my workflow and I'm and that's my
integration strategy i want the
demographics and I want the medications
and allergies because i'm going to take
that data and I'm gonna and I'm going to
present it to them and and iphone app /
android app / or whatever
ok so that's that's what we're going to
do as our workflow it'll be pretty
simple and it'll demo this tool so first
call i'm going to want to make his
search patients so we're going to go
back up here go back to api reference
professionally HR going to search for
search patients
ok so again parameter 1 through 6 is
what we're going to focus on you'll see
that we have optional and unused
parameters in this case I'm going to use
the optional parameter and parameter 1
has a search a search usage and it's
kind of like a google search what I'm
going to do is last name last name by
first okay in parameter 1 and the reason
that i'm searching for a patient by
their name is because i want to get that
patient ID okay and in sleuth you've
probably already noticed that this value
is pre-configured so I've already got
bill errands patient ID here which is
545 20 but when you build an integration
you're not going to have that
pre-configure you're gonna have to go
get it
alright so we're going to type search
search patients
ok and then in parameter 1 i'm going to
type the last
I'm first Aaron bill
ok then i'm going to hit enter
there we go so we've got searched
patients output output and you can see
the parameter 1 populated with what I
passed so we're going to go back to
search patients we're going to go to the
output specifications then we're going
to look for the field name for what I'm
looking for i'm looking for that patient
ID right so then i'm going to search by
the field game will go back to sleuth
i'll hit ctrl f i'll enter an ID and i'm
going to hit enter it's probably going
to go to the stub 1st so you're just
going to hit enter twice and then it
will find it
ok so there it is there's the ID it
looks like it's going through the middle
name as well and the organization ID but
it's right here at the very top ID okay
so this is the this is what I'm going to
want to use in the next call that I'm
making which is get patient and we're
going to go back here i'll close out
this and we're going to go back to
documentation APA reference
professionally HR ctrl-f get patient
okay so what this does is it returns the
demographics for for a patient right and
what it wants is it once the patient ID
and this is already configured in sleuth
so I'd but for this particular workflow
scenario i'm showing you that you have
to get the patient ID before you supply
it in this get patient call alright and
what I'm most interested in here is the
email
ok and there are I believe several
emails you've got your regular email and
you've got your home email i'm not sure
if there's another email him here but it
looks like there's at least two emails
listed here
alright so that's what i'm interested
them so go back here and i'm going to
type
get patient there we go okay
and since it's already pre-configured in
sleuth i'm just going to hit call unity
now
alright there we go now if i do i go
back here and then I searched by the
email copy that and then I do ctrl f
paste it in and hit enter
there we go I've got the test email so
that i would parse this out and I can
get that email address
okay and also go to the home email as
well
the search will but so that's sort of
how you use the tools functionality with
the search and and then how you would go
to your next call in your integration
workflow something else that i'll show
you and it may not be applicable in this
workflow but if if you wanted to send
something to a parameter without having
to retype it you can just right click
and send it to a particular parameter
and it'll go in the one thing is that
you'd want to set up your next call
first so i would set up my next call
let's just say it's get clinical get
clinical summary because that's the next
call will be using I would want to prep
my next call first and then send the
return to the appropriate parameter ok
let's clear that out
alright so in our workflow we were
interested in searching for the patient
to get the patient ID and then calling
get patient with that patient ID so we
can get the email addresses which we've
already done in this workflow our next
step is that we want to get the
medications and the allergies for a
particular patient
ok so we're going to go back to the API
reference professionally HR and the call
that i'm going to recommend for that is
get clinical summary
alright so what this does is it returns
a snapshot of a clinical history or
patients record right
we're going to go to parameter 1 through
6 per usual and it looks like parameter
1 is the required one and what we're
looking for here is what it does you can
pass in a section so I could pass an
allergies history immunizations and
it'll sort and only returned that
information or I could just call it with
I could just call it without any
parameters and it will return the entire
patient record so what I'm going to do
first is and you can see down here i can
do it based on section here are some of
the field names that I could search by
but so what I'm going to do first is I'm
going to come back here and i'm going to
call get clinical summary first without
any parameters just show you what it
would be like okay so call unity now
ok so here we go we've got the entire
clinical record for Bill Aaron all right
now if i scroll i'm sure you can see
just how much information this is it's
an awful lot of information so you could
use sluice search and you could type in
allergies
alright and then it would jump to each
appropriate section where there are
allergies
okay or you can do medications and we go
to each of the medications right
alternatively I could pass in the
section here so to show that let me type
in allergies i will right-click
allergies send it to parameter 1 and
call it
Wow look it's a much smaller output or
return
ok so that that would be if you're if
you're targeting certain information in
the clinical record like allergies
medications definitely use the filter
the filtering on the gate clinical
summary call
ok so i was able to get allergies here
that's great let me clear the parameters
out here and
and call it again I could do that or i
could just type of medications because i
know that's that's what the information
that I'm interested in so i'll just hit
i'll just call unity now
okay great and let's say that the the
particular medication i'm looking for is
lunesta ok alright there we go
I've got lunesta let's see if it's the
only only a lunesta in there it should
be ok and it is alright and so there you
have it you have the very basic workflow
but it shows you several of the features
of this tool the searchability the
ability to send the selected information
to a certain parameter if I so choose
the JSON output instead of the soap xml
output it shows you a little bit about
the configuration how you can change the
configuration you can change to your
unity service credentials to mimic and
impersonate your integration you can
change the endpoints the only
stipulation is that it has to be a
professional endpoint if you select a
professional drop-down it has to be a
touch works endpoint if you select touch
works drop-down sunrise etc etc okay
one of the things I'm not sure if I
mentioned but if you change these values
at all and it just stops working just
reset and it will reset it back to the
working defaults now I think one of the
most important things that left for I
guess the last step to talk about in
this video is the save log feature and
the workflow itself so to begin I'm
going to click this button down here
which will go to the first unity call I
made in the workflow get user
authentication
ok so you can see here that I called
parameter 1 Manning forget user
authentication for this endpoint if I
click on this button it will go to the
next one that the next unity magic
action that I called get server info
ok and let's say i was interested in the
unity born on date there you whenever
alright so the next call I made
that was a demonstration of the JSON
output
ok so let's get past that and this one
so the next call that I made with search
patients and i passed in bill Aaron
right and i was interested in the
patient ID which I got the next column
made us get patient and there I was
interested in the email right i think
there were several emails here
ah there's a work email is that ok
alright and then the the next call that
i made was get clinical summary and that
was a very large return so then I
decided to filter based on allergies and
then I decided to filter based on
medications right and if i click this
button again nothing happens because i
am at the last call right at the very
last call on my workflow if i click this
button it goes to the last one if I
click on this button it goes to the
first one so get user authentication was
the first one with parameter Manning get
clinical summary with parameter
medications was the last one so that's
how you can navigate your workflow and
map it out and once you're comfortable
with this once you're comfortable with
your workflow you can save it to log
okay now before we do this i want to
just show you one thing
currently there's not a way to clear out
the workflow but i will be adding that
in the future so if you want to start a
new start fresh you just close out of
unity sleuth and relaunch it and it will
refresh your workflow okay just so that
that's something i'm going to add the
future where you can just clear out this
workflow but um you have to a close out
the application relaunch it to get at a
new session workflow session but i'll be
adding a button for that soon so that
won't be an issue for many of you very
soon okay so now let's click on the Save
log which is one of them the biggest
features of the software
i'm going to click on save log and you
can see that i had saved my unity
workflow log as unity workflow log.txt
into my default unity sleuth directory
so that would be this folder over here
wherever i launched and and pinned my my
icon to taskbar so that would be over
here and there it is double click on it
here we have it so this has a little bit
more information than the than the
window does because the window is has a
real estate issue where this doesn't so
it's going to tell you when you passed
in nothing for different parameters and
as well as what you passed in ok on the
window its dynamic so it only shows
values that you passed in if you pass in
xml into the window and I can just do
that really quickly for you here we're
going to go to echo and just as a quick
example I'll do something like this
xml if you pass in xml to your parameter
it's going to say save log for xml
because i don't i don't want the xml to
appear in this window it would just it
would it would really mess up the the
presentation but it would save that if i
click on save log ok and i go into the
same place I was and I go down to the
last call that I made
it's going to present it in the log file
as you can see but in the window it's
going to say well that's not something I
want to show so i'm just going to tell
you to go to the save log to find it
ok but yeah so it what you can do is you
can take this entire log where it maps
out everything the call you made the
user ID the patient ID the endpoint the
token the parameters the output every
single step that was made in unity
sleuth with your unity service
credentials you can take this entire
thing and build and build an integration
based on these data structures
and you can do with json to if you're
interested in JSON so so i think that's
that's all I'm going to get into today
for for the first video describing this
this tool unity sleuth or unity
detective but i probably will have a
future videos as I add more features and
they'll be much shorter where I'm just
describing what's been added as opposed
to everything which is what which is
what I went over today as you can see
the build number is up here so you can
keep track of that if you're interested
there is an about sluice section which
will give you some more more details of
as well as the software disclaimer but
more details of of unity sleuth and its
its goals and some of the tips which I
probably already covered but maybe not
it also has some other things you can
find tooltips all throughout all
throughout this to help you
ok so i think that'll be it for today
and look forward to the next video which
may be in this
this video's description or there might
be a link on top of the video annotation
alright thanks very much but