Create Patient from Existing User

Request

Internal endpoint for creating a patient from an existing user

Security

sessionToken

Path

clinicIdstring^[a-f0-9]{24}$required

patientIdstring^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...required

Bodyapplication/json

permissionsobject(Patient Permissions)

isMigratedboolean

attestationSubmittedboolean

fullNamestring, non-empty

The full name of the patient

birthDatestring, (date)

Example:"2012-08-30"

mrnstring, non-empty

The medical record number of the patient

tagsArray of strings or null, unique(Patient Tag ID List)

sitesArray of objects(Site)

glycemicRangesobject(glycemicRanges.v1)

diagnosisTypestring(Diagnosis Type)

Enum:"type1""type2""type3c""gestational""prediabetes""lada""mody""other""notApplicable"""

Example:"type1"

curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/{patientId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "permissions": {
      "custodian": {},
      "view": {},
      "note": {},
      "upload": {}
    },
    "isMigrated": true,
    "attestationSubmitted": true,
    "fullName": "string",
    "birthDate": "2012-08-30",
    "mrn": "string",
    "tags": [
      "stringstringstringstring"
    ],
    "sites": [
      {
        "name": "string"
      }
    ],
    "glycemicRanges": {
      "type": "preset",
      "custom": {
        "name": "string",
        "thresholds": [
          {
            "name": "string",
            "upperBound": {
              "value": 0.1,
              "units": "mg/dL"
            },
            "inclusive": false
          }
        ]
      },
      "preset": "adaStandard"
    },
    "diagnosisType": "type1"
  }'

Responses

OK

Bodyapplication/json

idstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

emailstring, (email)

fullNamestring, non-emptyrequired

The full name of the patient

birthDatestring, (date)required

Example:"2012-08-30"

mrnstring, non-empty

The medical record number of the patient

tagsArray of strings or null, unique(Patient Tag ID List)

targetDevicesArray of strings(Target Devices)

When uploading data, the user selects a target device (typically make and model) of their data source (i.e. meter or pump) from a list. This selection is used by the Tidepool Uploader to select the correct drivers for communicating with the data source.

These values are stored in the user's profile so that they can be pre-selected on next use, thereby streamlining the process.

Example:

[
  "bayercontournext"
]

permissionsobject(Patient Permissions)

createdTimestring, (date-time)read-onlyrequired

updatedTimestring, (date-time)read-onlyrequired

attestationSubmittedboolean

dataSourcesArray of objects or null(Patient data source)

lastUploadReminderTimestring, (date-time)read-only

summaryobject(patientsummary.v1)read-only

A summary of a patients recent data

reviewsArray of objects or null(patientreview.v1)

connectionRequestsobject(providerconnectionrequests.v1)read-onlyrequired

Requests for each provider are listed in reverse chronological order

sitesArray of objects(Site)

glycemicRangesobject(glycemicRanges.v1)

diagnosisTypestring(Diagnosis Type)

Enum:"type1""type2""type3c""gestational""prediabetes""lada""mody""other""notApplicable"""

Example:"type1"

Response

{
  "id": "string",
  "email": "user@example.com",
  "fullName": "string",
  "birthDate": "2012-08-30",
  "mrn": "string",
  "tags": [
    "stringstringstringstring"
  ],
  "targetDevices": [
    "bayercontournext"
  ],
  "permissions": {
    "custodian": {},
    "view": {},
    "note": {},
    "upload": {}
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "attestationSubmitted": true,
  "dataSources": [
    { … }
  ],
  "lastUploadReminderTime": "2019-08-24T14:15:22Z",
  "summary": {
    "cgmStats": { … },
    "bgmStats": { … }
  },
  "reviews": [
    { … }
  ],
  "connectionRequests": {
    "twiist": [ … ],
    "dexcom": [ … ],
    "abbott": [ … ]
  },
  "sites": [
    { … }
  ],
  "glycemicRanges": {
    "type": "preset",
    "custom": { … },
    "preset": "adaStandard"
  },
  "diagnosisType": "type1"
}