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

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
mrnIdTypestring, non-emptyrequired
providerstringrequired
Enum:"xealth""redox"
scheduledReportsobject(scheduledreports.v1)required

Scheduled Report Settings

tagsobject(EHR Tags Settings)required

This configuration only applies to integrations using Redox Data Model

flowsheetsobject(Flowsheet Settings)required
notesobject(Note Settings)
Response
{
  "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
  },
  "notes": {
    "includeGMI": false
  }
}