Skip to content
Tidepool API/Clinics API/
/
Get EHR Settings

Clinics API (1.0)

Web service that stores information about clinics, clinicians and their patients

Download OpenAPI description
clinic.v1.json
clinic.v1.yaml
Overview
URL

https://www.tidepool.org

Tidepool

support@tidepool.org

License

BSD-2-Clause

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/clinic.v1/

integration

https://external.integration.tidepool.org/

production

https://api.tidepool.org/

dev1

https://dev1.dev.tidepool.org/

qa1

https://qa1.development.tidepool.org/

qa2

https://qa2.development.tidepool.org/

Clinics

Manage clinics, clinians and patients.

Operations

Redox Verify Endpoint

Request

Internal endpoint for Redox challenge verification

Security
sessionToken
curl -i -X POST \
  https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/redox/verify \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Get EHR Settings

Request

Returns EHR related settings

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/settings/ehr' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
enabledbooleanrequired

Enable or disable the EHR integration

sourceIdstringrequired
destinationIdsobject(Default Redox destination ID and per-model overrides)
procedureCodesobject(EHR Procedure Codes Map)required
procedureCodes.​enableSummaryReportsstringnon-empty

Procedure Code for Summary Statistics and PDF Reports subscription

procedureCodes.​disableSummaryReportsstringnon-empty
procedureCodes.​createAccountstringnon-empty
procedureCodes.​createAccountAndEnableReportsstring
mrnIdTypestringnon-emptyrequired
providerstringrequired
Enum"xealth""redox"
scheduledReportsobject(scheduledreports.v1)required

Scheduled Report Settings

scheduledReports.​onUploadEnabledbooleanrequired

Send a PDF Report and a Flowsheet to Redox after a dataset is uploaded.

scheduledReports.​onUploadNoteEventTypestring
Default "New"
Enum"New""Replace"
scheduledReports.​cadencestringrequired

The cadence of the scheduled reports. Disabling the scheduled reports does not affect reports which are generated after a dataset is uploaded.

Enum"1d""7d""14d""30d""DISABLED"
tagsobject(EHR Tags Settings)required

This configuration only applies to integrations using Redox Data Model

tags.​codesArray of strings

Codes of the clinical info items used to select the tags to associate with the patient. If defined, all tags of a patient will be replaced every time an enrollment order for the patient is processed.

tags.​separatorstringnon-empty

If set to a non-empty string, the tag values will be split using this separator

flowsheetsobject(Flowsheet Settings)required
flowsheets.​icodebooleanrequired

Determine if values should be sent in accorance with ICode2 rounding standards, or if we should send the values at higher precision.

Response
application/json
{
  "enabled": true,
  "sourceId": "string",
  "destinationIds": {
    "flowsheet": "string",
    "results": "string",
    "notes": "string"
  },
  "procedureCodes": {
    "enableSummaryReports": "string",
    "disableSummaryReports": "string",
    "createAccount": "string",
    "createAccountAndEnableReports": "string"
  },
  "mrnIdType": "string",
  "provider": "xealth",
  "scheduledReports": {
    "onUploadEnabled": true,
    "onUploadNoteEventType": "New",
    "cadence": "1d"
  },
  "tags": {
    "codes": [ … ],
    "separator": "string"
  },
  "flowsheets": {
    "icode": true
  }
}

Update EHR Settings

Request

Update EHR related settings for a clinic

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
enabledbooleanrequired

Enable or disable the EHR integration

sourceIdstringrequired
destinationIdsobject(Default Redox destination ID and per-model overrides)
procedureCodesobject(EHR Procedure Codes Map)required
procedureCodes.​enableSummaryReportsstringnon-empty

Procedure Code for Summary Statistics and PDF Reports subscription

procedureCodes.​disableSummaryReportsstringnon-empty
procedureCodes.​createAccountstringnon-empty
procedureCodes.​createAccountAndEnableReportsstring
mrnIdTypestringnon-emptyrequired
providerstringrequired
Enum"xealth""redox"
scheduledReportsobject(scheduledreports.v1)required

Scheduled Report Settings

scheduledReports.​onUploadEnabledbooleanrequired

Send a PDF Report and a Flowsheet to Redox after a dataset is uploaded.

scheduledReports.​onUploadNoteEventTypestring
Default "New"
Enum"New""Replace"
scheduledReports.​cadencestringrequired

The cadence of the scheduled reports. Disabling the scheduled reports does not affect reports which are generated after a dataset is uploaded.

Enum"1d""7d""14d""30d""DISABLED"
tagsobject(EHR Tags Settings)required

This configuration only applies to integrations using Redox Data Model

tags.​codesArray of strings

Codes of the clinical info items used to select the tags to associate with the patient. If defined, all tags of a patient will be replaced every time an enrollment order for the patient is processed.

tags.​separatorstringnon-empty

If set to a non-empty string, the tag values will be split using this separator

flowsheetsobject(Flowsheet Settings)required
flowsheets.​icodebooleanrequired

Determine if values should be sent in accorance with ICode2 rounding standards, or if we should send the values at higher precision.

curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/settings/ehr' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "enabled": true,
    "sourceId": "string",
    "destinationIds": {
      "flowsheet": "string",
      "results": "string",
      "notes": "string"
    },
    "procedureCodes": {
      "enableSummaryReports": "string",
      "disableSummaryReports": "string",
      "createAccount": "string",
      "createAccountAndEnableReports": "string"
    },
    "mrnIdType": "string",
    "provider": "xealth",
    "scheduledReports": {
      "onUploadEnabled": true,
      "onUploadNoteEventType": "New",
      "cadence": "1d"
    },
    "tags": {
      "codes": [
        "string"
      ],
      "separator": "string"
    },
    "flowsheets": {
      "icode": true
    }
  }'

Responses

OK

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Redox

Public endpoints invoked by Redox.

Operations