Skip to main content

Patient Care

Environments​

These are the URLs for the different environments:

Authentication​

Use Health Passport to generate the authentication token:

Creating a token

Access scopes​

To access the integration features, it is necessary to define the scopes when generating the token. To do this, just send the scopes patient_care_api and essential_health_api in the scopes field.

Example:

curl --location --request POST 'https://health-passport-homolog.azurefd.net/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=<client_id>' \
--data-urlencode 'client_secret=<client_secret>' \
--data-urlencode 'scopes=patient_care_api,essential_health_api' \
--data-urlencode 'grant_type=client_credentials'

Slugs​

Some API endpoints have parts of the URL to identify the client, program, and/or tracking, called slugs. Some of the possible slugs are:

  • clientSlug: identifies the client
  • programSlug: identifies the program
  • followupSlug: identifies the followup/pathology
info

These identifiers are only used in URLs and must be informed by our team along with the authentication credentials.

Security​

The API production environment is behind a firewall to prevent unwanted external access. The IP addresses of the servers that will make the requests must be sent to our team so they can be allowed access.

info

The testing environment is not behind a firewall, so it can be easily accessed by developers.