# Create a Prescription

Create a new prescription

Endpoint: POST /v1/clinics/{clinicId}/prescriptions
Version: 1.0
Security: sessionToken

## Path parameters:

  - `clinicId` (string, required)

## Request fields (application/json):

  - `firstName` (string)

  - `lastName` (string)

  - `birthday` (string)
    Example: "2012-08-30"

  - `mrn` (string)

  - `email` (string)
    An email address, as specified by [RFC 5322](https://datatracker.ietf.org/doc/html/rfc5322).
    Example: "example@tidepool.org"

  - `sex` (string)
    Enum: "male", "female", "undisclosed"

  - `weight` (object)

  - `weight.value` (number, required)

  - `weight.units` (string, required)

  - `yearOfDiagnosis` (integer)

  - `phoneNumber` (object)

  - `phoneNumber.countryCode` (string, required)

  - `phoneNumber.number` (string, required)

  - `initialSettings` (object)

  - `initialSettings.bloodGlucoseUnits` (any, required)

  - `initialSettings.basalRateSchedule` (array, required)
    A set of key-value pairs encoding the PWD's programmed basal schedules, where each key is a basal schedule name and each value is an array of basal schedule segment objects.

  - `initialSettings.basalRateSchedule.rate` (number, required)
    A floating point number >= 0 representing the amount of insulin delivered in Units per hour.

  - `initialSettings.basalRateSchedule.start` (integer, required)
    Integer value representing milliseconds since midnight.

  - `initialSettings.bloodGlucoseTargetSchedule` (array, required)

  - `initialSettings.bloodGlucoseTargetSchedule.start` (number, required)

  - `initialSettings.carbohydrateRatioSchedule` (array, required)

  - `initialSettings.carbohydrateRatioSchedule.amount` (number, required)

  - `initialSettings.insulinSensitivitySchedule` (array, required)

  - `initialSettings.basalRateMaximum` (object, required)

  - `initialSettings.bolusAmountMaximum` (object, required)

  - `initialSettings.bloodGlucoseSuspendThreshold` (object, required)

  - `initialSettings.insulinModel` (string, required)
    Enum: "rapidChild", "rapidAdult"

  - `initialSettings.pumpId` (string, required)

  - `initialSettings.cgmId` (string, required)

  - `initialSettings.bloodGlucoseTargetPhysicalActivity` (any)

  - `initialSettings.bloodGlucoseTargetPreprandial` (any)

  - `training` (string)
    Enum: "inPerson", "inModule"

  - `therapySettings` (string)
    Enum: "initial", "transferPumpSettings"

  - `prescriberTermsAccepted` (boolean)

  - `state` (string, required)
    Enum: "draft", "pending", "submitted", "claimed", "active", "inactive", "expired"

  - `calculator` (object)

  - `calculator.method` (string, required)
    Enum: "weight", "totalDailyDose", "totalDailyDoseAndWeight"

  - `calculator.weight` (number)
    Required if  is  or

  - `calculator.weightUnits` (string)
    Required if  is  or
    Enum: "kg", "lbs"

  - `calculator.totalDailyDoseScaleFactor` (number)
    Required if  is  or .  At present, only options are  and

  - `calculator.totalDailyDose` (number)
    Required if  is  or

  - `calculator.recommendedBasalRate` (number, required)

  - `calculator.recommendedInsulinSensitivity` (number, required)

  - `calculator.recommendedCarbohydrateRatio` (number, required)

  - `revisionHash` (string, required)
    Canonicalized and SHA-512-encrypted hex output of the sent revision payload

  - `caregiverFirstName` (string)

  - `caregiverLastName` (string)

  - `accountType` (string)
    Enum: "patient", "caregiver"

## Response 201 fields (application/json):

  - `id` (string, required)
    String representation of a resource id

  - `patientUserId` (string)
    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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `state` (string, required)
    Enum: "draft", "pending", "submitted", "claimed", "active", "inactive", "expired"

  - `expirationTime` (string)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `prescriberUserId` (string)
    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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `createdTime` (string, required)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `createdUserId` (string, required)
    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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `deletedTime` (string)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `deletedUserId` (string)
    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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `modifiedTime` (string, required)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `modifiedUserId` (string, required)
    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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `latestRevision` (object, required)

  - `latestRevision.revisionId` (integer)

  - `latestRevision.attributes` (object)

  - `latestRevision.attributes.firstName` (string)

  - `latestRevision.attributes.lastName` (string)

  - `latestRevision.attributes.birthday` (string)
    Example: "2012-08-30"

  - `latestRevision.attributes.mrn` (string)

  - `latestRevision.attributes.email` (string)
    An email address, as specified by [RFC 5322](https://datatracker.ietf.org/doc/html/rfc5322).
    Example: "example@tidepool.org"

  - `latestRevision.attributes.sex` (string)
    Enum: "male", "female", "undisclosed"

  - `latestRevision.attributes.weight` (object)

  - `latestRevision.attributes.weight.value` (number, required)

  - `latestRevision.attributes.weight.units` (string, required)

  - `latestRevision.attributes.yearOfDiagnosis` (integer)

  - `latestRevision.attributes.phoneNumber` (object)

  - `latestRevision.attributes.phoneNumber.countryCode` (string, required)

  - `latestRevision.attributes.phoneNumber.number` (string, required)

  - `latestRevision.attributes.initialSettings` (object)

  - `latestRevision.attributes.initialSettings.bloodGlucoseUnits` (any, required)

  - `latestRevision.attributes.initialSettings.basalRateSchedule` (array, required)
    A set of key-value pairs encoding the PWD's programmed basal schedules, where each key is a basal schedule name and each value is an array of basal schedule segment objects.

  - `latestRevision.attributes.initialSettings.basalRateSchedule.rate` (number, required)
    A floating point number >= 0 representing the amount of insulin delivered in Units per hour.

  - `latestRevision.attributes.initialSettings.basalRateSchedule.start` (integer, required)
    Integer value representing milliseconds since midnight.

  - `latestRevision.attributes.initialSettings.bloodGlucoseTargetSchedule` (array, required)

  - `latestRevision.attributes.initialSettings.bloodGlucoseTargetSchedule.start` (number, required)

  - `latestRevision.attributes.initialSettings.carbohydrateRatioSchedule` (array, required)

  - `latestRevision.attributes.initialSettings.carbohydrateRatioSchedule.amount` (number, required)

  - `latestRevision.attributes.initialSettings.insulinSensitivitySchedule` (array, required)

  - `latestRevision.attributes.initialSettings.basalRateMaximum` (object, required)

  - `latestRevision.attributes.initialSettings.bolusAmountMaximum` (object, required)

  - `latestRevision.attributes.initialSettings.bloodGlucoseSuspendThreshold` (object, required)

  - `latestRevision.attributes.initialSettings.insulinModel` (string, required)
    Enum: "rapidChild", "rapidAdult"

  - `latestRevision.attributes.initialSettings.pumpId` (string, required)

  - `latestRevision.attributes.initialSettings.cgmId` (string, required)

  - `latestRevision.attributes.initialSettings.bloodGlucoseTargetPhysicalActivity` (any)

  - `latestRevision.attributes.initialSettings.bloodGlucoseTargetPreprandial` (any)

  - `latestRevision.attributes.training` (string)
    Enum: "inPerson", "inModule"

  - `latestRevision.attributes.therapySettings` (string)
    Enum: "initial", "transferPumpSettings"

  - `latestRevision.attributes.prescriberTermsAccepted` (boolean)

  - `latestRevision.attributes.calculator` (object)

  - `latestRevision.attributes.calculator.method` (string, required)
    Enum: "weight", "totalDailyDose", "totalDailyDoseAndWeight"

  - `latestRevision.attributes.calculator.weight` (number)
    Required if  is  or

  - `latestRevision.attributes.calculator.weightUnits` (string)
    Required if  is  or
    Enum: "kg", "lbs"

  - `latestRevision.attributes.calculator.totalDailyDoseScaleFactor` (number)
    Required if  is  or .  At present, only options are  and

  - `latestRevision.attributes.calculator.totalDailyDose` (number)
    Required if  is  or

  - `latestRevision.attributes.calculator.recommendedBasalRate` (number, required)

  - `latestRevision.attributes.calculator.recommendedInsulinSensitivity` (number, required)

  - `latestRevision.attributes.calculator.recommendedCarbohydrateRatio` (number, required)

  - `latestRevision.attributes.revisionHash` (string, required)
    Canonicalized and SHA-512-encrypted hex output of the sent revision payload

  - `latestRevision.attributes.caregiverFirstName` (string)

  - `latestRevision.attributes.caregiverLastName` (string)

  - `latestRevision.attributes.accountType` (string)
    Enum: "patient", "caregiver"

  - `clinicId` (string, required)
    Clinic identifier.
    Example: "2fe2488217ee43e1b2e83c2f"

## Response 400 fields (application/json):

  - `code` (integer)
    Error reason code

  - `reason` (string)
    Error reason text

## Response 401 fields (application/json):

  - `code` (integer)
    Error reason code

  - `reason` (string)
    Error reason text

## Response 403 fields (application/json):

  - `code` (integer)
    Error reason code

  - `reason` (string)
    Error reason text

## Response 500 fields (application/json):

  - `code` (integer)
    Error reason code

  - `reason` (string)
    Error reason text