Skip to main content

Vanya Client Integration

· 3 min read
Confused-Moniker
Maintainer of IGUHealth

Vanya client is a desktop app that allows you to view data in FHIR. It works with a variety of FHIR servers and can be a great way to check for conformance and data quality more on that later.

How to integrate Vanya with Iguhealth​

OAuth Client Credentials​

  1. Go to the admin application and create a new ClientApplication.
  2. Set the grant type to client_credentials.
  3. Set the response type to token.
  4. Set the secret to a secure value.
  5. Hit Actions and create
  6. Mark down the client ID and secret.
  7. Click Security->AccessPolicy in the admin app and create a new access policy.
  8. Create AccessPolicy with the type set to `Full Access'.
  9. Under Target.Link reference the ClientApplication created on step 5.
  10. Open the Vanya client.
  11. Click Add New Server.
  12. Go to Settings on the Admin App and copy the FHIR R4 URL.
  13. Paste the URL in the Vanya Client for the URL.
  14. In Vanya, click OAuth2.
  15. Copy and paste the token endpoint from the admin app settings.
  16. Copy the clientID from step 5 and paste it in Vanya.
  17. Copy the client secret from step 5 and paste it in Vanya.
  18. Set the grant type to client_credentials.
  19. Click Save.

Basic Authentication​

  1. Go to the admin application and create a new ClientApplication.
  2. Set the grant type to basic_auth.
  3. Set the response type to token.
  4. Set the secret to a secure value.
  5. Hit Actions and create
  6. Mark down the client ID and secret.
  7. Click Security->AccessPolicy in Admin App and create a new access policy.
  8. Create AccessPolicy with the type set to `Full Access'.
  9. Under Target.Link reference the client application created on step 5.
  10. Use the below widget and enter the client ID and secret, then copy the authorization header value.

Below is a simple form to generate an Authorization header for basic authentication.

  1. Open the Vanya client.
  2. Click Add New Server.
  3. Click the Request Headers tab, create a key Authorization and paste in the value from step 10.
  4. Go to Settings on the Admin App and copy the FHIR R4 URL.
  5. Paste the URL in the Vanya Client for the URL.
  6. Click Save.

Vanya Client discovered a non-conformant aspect of our server​

We use nanoid to generate unique identifiers for our resources. Vanya client discovered that our use of the default alphabet for nanoid, is not FHIR compliant. Specifically the _ is a character not allowed in FHIR ids.