Skip to main content
PUT
/
user
/
patient
/
doses
/
{dose_id}
Update Dose
curl --request PUT \
  --url https://api.decodahealth.com/user/patient/doses/{dose_id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "doseDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "unit": "<string>",
  "sideEffects": "<string>",
  "administrationLocation": "<string>",
  "amount": 123,
  "quantity": 123,
  "frequency": "<string>",
  "comment": "<string>",
  "lotNumber": "<string>",
  "stockId": "<string>",
  "noteId": "<string>",
  "signedOffProviderId": "<string>",
  "signedOffDate": "2023-11-07T05:31:56Z"
}
'
{
  "medicationId": "<string>",
  "patientId": "<string>",
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "providerId": "<string>",
  "doseDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "unit": "<string>",
  "sideEffects": "<string>",
  "administrationLocation": "<string>",
  "amount": 123,
  "quantity": 1,
  "frequency": "<string>",
  "comment": "<string>",
  "lotNumber": "<string>",
  "stockId": "<string>",
  "noteId": "<string>",
  "signedOffProviderId": "<string>",
  "signedOffDate": "2023-11-07T05:31:56Z",
  "isArchived": false,
  "updatedDate": "2023-11-07T05:31:56Z",
  "provider": {
    "id": "<string>",
    "type": "PROVIDER",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  },
  "signedOffProvider": {
    "id": "<string>",
    "type": "PROVIDER",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  }
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
dose_id
string
required

Body

application/json

Schema for updating an existing dose record.

​
doseDate
string<date-time> | null
​
name
string | null
​
unit
string | null
​
sideEffects
string | null
​
administrationLocation
string | null
​
amount
number | null
​
quantity
number | null
​
frequency
string | null
​
comment
string | null
​
lotNumber
string | null
​
stockId
string | null
​
noteId
string | null
​
signedOffProviderId
string | null
​
signedOffDate
string<date-time> | null

Response

Successful Response

Schema for returning dose information with computed fields.

​
medicationId
string
required
​
patientId
string
required
​
id
string
required
​
createdDate
string<date-time>
required
​
providerId
string | null
​
doseDate
string<date-time> | null
​
name
string | null
​
unit
string | null
​
sideEffects
string | null
​
administrationLocation
string | null
​
amount
number | null
​
quantity
number
default:1
​
frequency
string | null
​
comment
string | null
​
lotNumber
string | null
​
stockId
string | null
​
noteId
string | null
​
signedOffProviderId
string | null
​
signedOffDate
string<date-time> | null
​
isArchived
boolean
default:false
​
updatedDate
string<date-time> | null
​
provider
UserTiny · object
​
signedOffProvider
UserTiny · object