First iteration of the PSM API is up and running

15 views
Skip to first unread message

Cecilia Donnelly

unread,
Mar 12, 2018, 10:53:08 AM3/12/18
to psm...@googlegroups.com
Hi all,

I'm happy to say that the first version of the PSM API is complete and deployed on the demo server.  Many thanks to Jason Owen for his work on this!  This API will be used first by the Poplin project, and Dave and Pace have also been generous with their time in designing and testing it.  Thank you!

If anyone is interested in testing out the API, there are a couple ways to do so:

1. Find the ID of an application for enrollment you'd like to access through the API.  The next version of the API will implement search, which will make this step unnecessary.  To find this ID, you can log in to the demo site at https://demo.psm.solutionguidance.com/cms/login.  Click "view" or "edit" on any application and look at the end of the URL to find its ID.  Or you can use one of the following:

- Draft: 1438 (this might not stay a draft forever)
- Pending: 1463
- Denied: 648

2a. Test in your browser
To look at an API response in your browser, navigate to https://demo.psm.solutionguidance.com/cms/fhir/Task/1463 (for example).  Your browser might ask you if you want to save a file when you navigate to that page.  I'd suggest choosing to open it in the browser, but either will work.  The application ID that you found in step 1 forms the last part of the URL, so you can replace "1463" with any of the other IDs.  If you choose an ID that doesn't exist on the server, you'll get a "not found" page.  Testing the API this way will give you a response that looks like the one in the postscript below.

2b. Test from the command line
If you'd rather look at the API result on the command line, you can easily do so.  Run the command `curl https://demo.psm.solutionguidance.com/cms/fhir/Task/1463` to get information about that application.

If you're not comfortable on the command line that is more than fine.  The same information is presented no matter how you look at it.

No real information is stored on our demo server -- all the application and provider data is fake and for testing purposes only.

For more information about the API, please look at the original pull request, which also links to a discussion in the issue.  Respond here with any questions or comments -- I look forward to talking more about this.

Cecilia


P.S. An example of the type of response you will see in your browser:

<Task xmlns="http://hl7.org/fhir">
   <contained>
      <Practitioner xmlns="http://hl7.org/fhir">
         <id value="1489"/>
         <identifier>
            <system value="http://hl7.org/fhir/sid/us-ssn"/>
            <value value="111001111"/>
         </identifier>
         <identifier>
            <system value="http://hl7.org/fhir/sid/us-npi"/>
            <value value="0000000006"/>
         </identifier>
         <name>
            <family value="Test"/>
            <given value="Cecilia"/>
         </name>
      </Practitioner>
   </contained>
   <identifier>
      <value value="1463"/>
   </identifier>
   <status value="requested"/>
   <intent value="proposal"/>
   <requester>
      <agent>
         <reference value="#1489"/>
      </agent>
   </requester>
   <input>
      <type>
         <text value="Provider Type"/>
      </type>
      <valueString value="Dentist"/>
   </input>
</Task>


Cecilia Donnelly

unread,
Mar 29, 2018, 11:46:52 AM3/29/18
to psm...@googlegroups.com
Hello all,

As promised in my last missive, the API now includes searching.  The testing options remain much the same: command line or browser.

To find all the rejected applications on the demo server, try a search like: https://demo.psm.solutionguidance.com/cms/fhir/Task?status=Rejected.

The available search terms are "name," "status," "npi," and "providerType."  You can see more details in the original pull request.  You can combine search terms to get more exact results, like searching for all the dentists named Mary (https://demo.psm.solutionguidance.com/cms/fhir/Task?providerType=Dentist&name=Mary, though I don't think we have any yet!).  Let us know if you try it out.

Talk soon,
Cecilia


--
Reply all
Reply to author
Forward
0 new messages