Skip to content
Tidepool API/Prescriptions API/
/
Update Prescription State

Prescriptions API (1.0)

Prescription service for Tidepool Loop

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

https://support.tidepool.org/

API Support

support@tidepool.org

License

BSD 2-Clause "Simplified" License

Terms of Service

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/prescription.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/

Internal

APIs intended for internal use by Tidepool.

Prescriptions

Manage prescriptions for Tidepool Loop

Operations

List Prescriptions

Request

Retrieve the list of prescriptions created by clinic members

Security
sessionToken
Path
clinicIdstringrequired
Query
idstring
patientUserIdstring
patientEmailstring(email)
statestring
createdAfterstring(date-time)

inclusive

createdBeforestring(date-time)

exclusive

modifiedAfterstring(date-time)

inclusive

modifiedBeforestring(date-time)

exclusive

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/clinics/{clinicId}/prescriptions?id=string&patientUserId=string&patientEmail=user%40example.com&state=string&createdAfter=2019-08-24T14%3A15%3A22Z&createdBefore=2019-08-24T14%3A15%3A22Z&modifiedAfter=2019-08-24T14%3A15%3A22Z&modifiedBefore=2019-08-24T14%3A15%3A22Z' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/jsonArray [
idstring(Object Id)= 24 characters^[a-f0-9]{24}$read-onlyrequired

String representation of a resource id

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

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

statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
expirationTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
prescriberUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

createdTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(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

deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

modifiedTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(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

latestRevisionobject(Prescription Revision)required
latestRevision.​revisionIdinteger(int32)
latestRevision.​attributesobject(Revision Attributes)
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
]
Response
application/json
[
  {
    "id": "stringstringstringstring",
    "patientUserId": "string",
    "state": "draft",
    "expirationTime": "2017-02-06T02:37:46Z",
    "prescriberUserId": "string",
    "createdTime": "2017-02-06T02:37:46Z",
    "createdUserId": "string",
    "deletedTime": "2017-02-06T02:37:46Z",
    "deletedUserId": "string",
    "modifiedTime": "2017-02-06T02:37:46Z",
    "modifiedUserId": "string",
    "latestRevision": { … },
    "clinicId": "2fe2488217ee43e1b2e83c2f"
  }
]

Create a Prescription

Request

Create a new prescription

Security
sessionToken
Path
clinicIdstringrequired
Bodyapplication/json
firstNamestring
lastNamestring
birthdaystring(date)(Birthday)
Example: "2012-08-30"
mrnstring
emailstring(email)(Email Address)>= 6 characters

An email address, as specified by RFC 5322.

Example: "example@tidepool.org"
sexstring
Enum"male""female""undisclosed"
weightobject(Weight)
yearOfDiagnosisinteger(int32)>= 1900
phoneNumberobject(Phone Number)
initialSettingsobject(Pump Settings)
trainingstring
Enum"inPerson""inModule"
therapySettingsstring
Enum"initial""transferPumpSettings"
prescriberTermsAcceptedboolean
statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
calculatorobject(calculator.v1)
revisionHashstring^[A-Fa-f0-9]{64}$required

Canonicalized and SHA-512-encrypted hex output of the sent revision payload

caregiverFirstNamestring
caregiverLastNamestring
accountTypestring
Enum"patient""caregiver"
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/clinics/{clinicId}/prescriptions' \
  -H 'Content-Type: application/json' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "birthday": "2012-08-30",
    "mrn": "string",
    "email": "example@tidepool.org",
    "sex": "male",
    "weight": {
      "value": 0,
      "units": "string"
    },
    "yearOfDiagnosis": 1900,
    "phoneNumber": {
      "countryCode": "string",
      "number": "string"
    },
    "initialSettings": {
      "bloodGlucoseUnits": "mg/dL",
      "basalRateSchedule": [
        {
          "rate": 20,
          "start": 0
        }
      ],
      "bloodGlucoseTargetSchedule": [
        {
          "high": 180,
          "low": 80,
          "start": 86400000
        }
      ],
      "carbohydrateRatioSchedule": [
        {
          "start": 86400000,
          "amount": 250
        }
      ],
      "insulinSensitivitySchedule": [
        {
          "amount": 105,
          "start": 86400000
        }
      ],
      "basalRateMaximum": {
        "units": "Units/hour",
        "value": 100
      },
      "bolusAmountMaximum": {
        "units": "Units",
        "value": 100
      },
      "bloodGlucoseSuspendThreshold": {
        "units": "mg/dL",
        "value": 105
      },
      "insulinModel": "rapidAdult",
      "pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
      "cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
      "bloodGlucoseTargetPhysicalActivity": {
        "high": 180,
        "low": 80
      },
      "bloodGlucoseTargetPreprandial": {
        "high": 180,
        "low": 80
      }
    },
    "training": "inPerson",
    "therapySettings": "initial",
    "prescriberTermsAccepted": true,
    "state": "draft",
    "calculator": {
      "method": "weight",
      "weight": 0.1,
      "weightUnits": "kg",
      "totalDailyDoseScaleFactor": 1,
      "totalDailyDose": 0.1,
      "recommendedBasalRate": 0.1,
      "recommendedInsulinSensitivity": 0.1,
      "recommendedCarbohydrateRatio": 0.1
    },
    "revisionHash": "string",
    "caregiverFirstName": "string",
    "caregiverLastName": "string",
    "accountType": "patient"
  }'

Responses

Created

Bodyapplication/json
idstring(Object Id)= 24 characters^[a-f0-9]{24}$read-onlyrequired

String representation of a resource id

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

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

statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
expirationTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
prescriberUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

createdTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(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

deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

modifiedTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(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

latestRevisionobject(Prescription Revision)required
latestRevision.​revisionIdinteger(int32)
latestRevision.​attributesobject(Revision Attributes)
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
Response
application/json
{
  "id": "stringstringstringstring",
  "patientUserId": "string",
  "state": "draft",
  "expirationTime": "2017-02-06T02:37:46Z",
  "prescriberUserId": "string",
  "createdTime": "2017-02-06T02:37:46Z",
  "createdUserId": "string",
  "deletedTime": "2017-02-06T02:37:46Z",
  "deletedUserId": "string",
  "modifiedTime": "2017-02-06T02:37:46Z",
  "modifiedUserId": "string",
  "latestRevision": {
    "revisionId": 0,
    "attributes": { … }
  },
  "clinicId": "2fe2488217ee43e1b2e83c2f"
}

Get Prescription

Request

Retrieve a prescription by id

Security
sessionToken
Path
prescriptionIdstringrequired
clinicIdstringrequired
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/clinics/{clinicId}/prescriptions/{prescriptionId}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(Object Id)= 24 characters^[a-f0-9]{24}$read-onlyrequired

String representation of a resource id

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

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

statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
expirationTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
prescriberUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

createdTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(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

deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

modifiedTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(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

latestRevisionobject(Prescription Revision)required
latestRevision.​revisionIdinteger(int32)
latestRevision.​attributesobject(Revision Attributes)
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
Response
application/json
{
  "id": "stringstringstringstring",
  "patientUserId": "string",
  "state": "draft",
  "expirationTime": "2017-02-06T02:37:46Z",
  "prescriberUserId": "string",
  "createdTime": "2017-02-06T02:37:46Z",
  "createdUserId": "string",
  "deletedTime": "2017-02-06T02:37:46Z",
  "deletedUserId": "string",
  "modifiedTime": "2017-02-06T02:37:46Z",
  "modifiedUserId": "string",
  "latestRevision": {
    "revisionId": 0,
    "attributes": { … }
  },
  "clinicId": "2fe2488217ee43e1b2e83c2f"
}

Delete Prescription

Request

Clinician only endpoint to delete a prescription. Works only when the prescription has status draft.

Security
sessionToken
Path
prescriptionIdstringrequired
clinicIdstringrequired
curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/clinics/{clinicId}/prescriptions/{prescriptionId}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

OK

Response
No content

Create new revision

Request

Add a new revision to a prescription which is still a draft.

Security
sessionToken
Path
prescriptionIdstringrequired
clinicIdstringrequired
Bodyapplication/json
firstNamestring
lastNamestring
birthdaystring(date)(Birthday)
Example: "2012-08-30"
mrnstring
emailstring(email)(Email Address)>= 6 characters

An email address, as specified by RFC 5322.

Example: "example@tidepool.org"
sexstring
Enum"male""female""undisclosed"
weightobject(Weight)
yearOfDiagnosisinteger(int32)>= 1900
phoneNumberobject(Phone Number)
initialSettingsobject(Pump Settings)
trainingstring
Enum"inPerson""inModule"
therapySettingsstring
Enum"initial""transferPumpSettings"
prescriberTermsAcceptedboolean
statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
calculatorobject(calculator.v1)
revisionHashstring^[A-Fa-f0-9]{64}$required

Canonicalized and SHA-512-encrypted hex output of the sent revision payload

caregiverFirstNamestring
caregiverLastNamestring
accountTypestring
Enum"patient""caregiver"
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/clinics/{clinicId}/prescriptions/{prescriptionId}/revisions' \
  -H 'Content-Type: application/json' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
  -d '{
    "firstName": "string",
    "lastName": "string",
    "birthday": "2012-08-30",
    "mrn": "string",
    "email": "example@tidepool.org",
    "sex": "male",
    "weight": {
      "value": 0,
      "units": "string"
    },
    "yearOfDiagnosis": 1900,
    "phoneNumber": {
      "countryCode": "string",
      "number": "string"
    },
    "initialSettings": {
      "bloodGlucoseUnits": "mg/dL",
      "basalRateSchedule": [
        {
          "rate": 20,
          "start": 0
        }
      ],
      "bloodGlucoseTargetSchedule": [
        {
          "high": 180,
          "low": 80,
          "start": 86400000
        }
      ],
      "carbohydrateRatioSchedule": [
        {
          "start": 86400000,
          "amount": 250
        }
      ],
      "insulinSensitivitySchedule": [
        {
          "amount": 105,
          "start": 86400000
        }
      ],
      "basalRateMaximum": {
        "units": "Units/hour",
        "value": 100
      },
      "bolusAmountMaximum": {
        "units": "Units",
        "value": 100
      },
      "bloodGlucoseSuspendThreshold": {
        "units": "mg/dL",
        "value": 105
      },
      "insulinModel": "rapidAdult",
      "pumpId": "6c959a5b-72ed-42d2-b9cd-0943e9536d18",
      "cgmId": "fdcf79e5-bf1b-4255-aa02-cde99493e17e",
      "bloodGlucoseTargetPhysicalActivity": {
        "high": 180,
        "low": 80
      },
      "bloodGlucoseTargetPreprandial": {
        "high": 180,
        "low": 80
      }
    },
    "training": "inPerson",
    "therapySettings": "initial",
    "prescriberTermsAccepted": true,
    "state": "draft",
    "calculator": {
      "method": "weight",
      "weight": 0.1,
      "weightUnits": "kg",
      "totalDailyDoseScaleFactor": 1,
      "totalDailyDose": 0.1,
      "recommendedBasalRate": 0.1,
      "recommendedInsulinSensitivity": 0.1,
      "recommendedCarbohydrateRatio": 0.1
    },
    "revisionHash": "string",
    "caregiverFirstName": "string",
    "caregiverLastName": "string",
    "accountType": "patient"
  }'

Responses

OK

Bodyapplication/json
revisionIdinteger(int32)
attributesobject(Revision Attributes)
Response
application/json
{
  "revisionId": 0,
  "attributes": {
    "firstName": "string",
    "lastName": "string",
    "birthday": "2012-08-30",
    "mrn": "string",
    "email": "example@tidepool.org",
    "sex": "male",
    "weight": { … },
    "yearOfDiagnosis": 1900,
    "phoneNumber": { … },
    "initialSettings": { … },
    "training": "inPerson",
    "therapySettings": "initial",
    "prescriberTermsAccepted": true,
    "state": "draft",
    "calculator": { … },
    "revisionHash": "string",
    "createdUserId": "string",
    "caregiverFirstName": "string",
    "caregiverLastName": "string",
    "accountType": "patient",
    "createdTime": "2017-02-06T02:37:46Z"
  }
}

Claim Prescription

Request

Claim a submitted prescription using an access code and date of birth.

Security
sessionToken
Path
userIdstringrequired
Bodyapplication/json
accessCodestring(Access Code)= 6 characters^[A-HJ-NP-Z2-9]+$required
birthdaystring(date)(Birthday)required
Example: "2012-08-30"
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/patients/{userId}/prescriptions' \
  -H 'Content-Type: application/json' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
  -d '{
    "accessCode": "string",
    "birthday": "2012-08-30"
  }'

Responses

OK

Bodyapplication/json
idstring(Object Id)= 24 characters^[a-f0-9]{24}$read-onlyrequired

String representation of a resource id

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

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

statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
expirationTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
prescriberUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

createdTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(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

deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

modifiedTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(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

latestRevisionobject(Prescription Revision)required
latestRevision.​revisionIdinteger(int32)
latestRevision.​attributesobject(Revision Attributes)
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
Response
application/json
{
  "id": "stringstringstringstring",
  "patientUserId": "string",
  "state": "draft",
  "expirationTime": "2017-02-06T02:37:46Z",
  "prescriberUserId": "string",
  "createdTime": "2017-02-06T02:37:46Z",
  "createdUserId": "string",
  "deletedTime": "2017-02-06T02:37:46Z",
  "deletedUserId": "string",
  "modifiedTime": "2017-02-06T02:37:46Z",
  "modifiedUserId": "string",
  "latestRevision": {
    "revisionId": 0,
    "attributes": { … }
  },
  "clinicId": "2fe2488217ee43e1b2e83c2f"
}

List Prescriptions for Patient

Request

Retrieve a list of prescription that the user has claimed

Security
sessionToken
Path
userIdstringrequired
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/patients/{userId}/prescriptions' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

OK

Get Prescription for User

Request

Retrieve a prescription by id

Security
sessionToken
Path
userIdstringrequired
prescriptionIdstringrequired
curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/patients/{userId}/prescriptions/{prescriptionId}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(Object Id)= 24 characters^[a-f0-9]{24}$read-onlyrequired

String representation of a resource id

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

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

statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
expirationTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
prescriberUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

createdTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(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

deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

modifiedTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(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

latestRevisionobject(Prescription Revision)required
latestRevision.​revisionIdinteger(int32)
latestRevision.​attributesobject(Revision Attributes)
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
Response
application/json
{
  "id": "stringstringstringstring",
  "patientUserId": "string",
  "state": "draft",
  "expirationTime": "2017-02-06T02:37:46Z",
  "prescriberUserId": "string",
  "createdTime": "2017-02-06T02:37:46Z",
  "createdUserId": "string",
  "deletedTime": "2017-02-06T02:37:46Z",
  "deletedUserId": "string",
  "modifiedTime": "2017-02-06T02:37:46Z",
  "modifiedUserId": "string",
  "latestRevision": {
    "revisionId": 0,
    "attributes": { … }
  },
  "clinicId": "2fe2488217ee43e1b2e83c2f"
}

Update Prescription State

Request

Update prescription state

Security
sessionToken
Path
userIdstringrequired
prescriptionIdstringrequired
curl -i -X PATCH \
  'https://tidepool.redocly.app/_mock/reference/prescription.v1/v1/patients/{userId}/prescriptions/{prescriptionId}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(Object Id)= 24 characters^[a-f0-9]{24}$read-onlyrequired

String representation of a resource id

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

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

statestring(Prescriptions State)required
Enum"draft""pending""submitted""claimed""active""inactive""expired"
expirationTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
prescriberUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

createdTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
createdUserIdstring(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

deletedTimestring(date-time)(Date/Time)

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
deletedUserIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

modifiedTimestring(date-time)(Date/Time)required

RFC 3339 / ISO 8601 timestamp with timezone information

Example: "2017-02-06T02:37:46Z"
modifiedUserIdstring(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

latestRevisionobject(Prescription Revision)required
latestRevision.​revisionIdinteger(int32)
latestRevision.​attributesobject(Revision Attributes)
clinicIdstring(Clinic ID)= 24 characters^[a-f0-9]{24}$read-onlyrequired

Clinic identifier.

Example: "2fe2488217ee43e1b2e83c2f"
Response
application/json
{
  "id": "stringstringstringstring",
  "patientUserId": "string",
  "state": "draft",
  "expirationTime": "2017-02-06T02:37:46Z",
  "prescriberUserId": "string",
  "createdTime": "2017-02-06T02:37:46Z",
  "createdUserId": "string",
  "deletedTime": "2017-02-06T02:37:46Z",
  "deletedUserId": "string",
  "modifiedTime": "2017-02-06T02:37:46Z",
  "modifiedUserId": "string",
  "latestRevision": {
    "revisionId": 0,
    "attributes": { … }
  },
  "clinicId": "2fe2488217ee43e1b2e83c2f"
}