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"
}
'import requests
url = "https://api.decodahealth.com/user/patient/doses/{dose_id}"
payload = {
"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"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.decodahealth.com/user/patient/doses/{dose_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/user/patient/doses/{dose_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/user/patient/doses/{dose_id}"
payload := strings.NewReader("{\n \"doseDate\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"sideEffects\": \"<string>\",\n \"administrationLocation\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"frequency\": \"<string>\",\n \"comment\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"stockId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"signedOffProviderId\": \"<string>\",\n \"signedOffDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.decodahealth.com/user/patient/doses/{dose_id}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"doseDate\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"sideEffects\": \"<string>\",\n \"administrationLocation\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"frequency\": \"<string>\",\n \"comment\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"stockId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"signedOffProviderId\": \"<string>\",\n \"signedOffDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/user/patient/doses/{dose_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"doseDate\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"sideEffects\": \"<string>\",\n \"administrationLocation\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"frequency\": \"<string>\",\n \"comment\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"stockId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"signedOffProviderId\": \"<string>\",\n \"signedOffDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"signedOffProvider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Patients
Update Dose
Update an existing dose record. Updating a dose will unsign it, requiring re-approval.
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"
}
'import requests
url = "https://api.decodahealth.com/user/patient/doses/{dose_id}"
payload = {
"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"
}
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.decodahealth.com/user/patient/doses/{dose_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/user/patient/doses/{dose_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: application/json",
"TENANT: <tenant>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.decodahealth.com/user/patient/doses/{dose_id}"
payload := strings.NewReader("{\n \"doseDate\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"sideEffects\": \"<string>\",\n \"administrationLocation\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"frequency\": \"<string>\",\n \"comment\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"stockId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"signedOffProviderId\": \"<string>\",\n \"signedOffDate\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.decodahealth.com/user/patient/doses/{dose_id}")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"doseDate\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"sideEffects\": \"<string>\",\n \"administrationLocation\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"frequency\": \"<string>\",\n \"comment\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"stockId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"signedOffProviderId\": \"<string>\",\n \"signedOffDate\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.decodahealth.com/user/patient/doses/{dose_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"doseDate\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"unit\": \"<string>\",\n \"sideEffects\": \"<string>\",\n \"administrationLocation\": \"<string>\",\n \"amount\": 123,\n \"quantity\": 123,\n \"frequency\": \"<string>\",\n \"comment\": \"<string>\",\n \"lotNumber\": \"<string>\",\n \"stockId\": \"<string>\",\n \"noteId\": \"<string>\",\n \"signedOffProviderId\": \"<string>\",\n \"signedOffDate\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
},
"signedOffProvider": {
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"phoneNumber": "<string>",
"email": "<string>",
"locationId": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Body
application/json
Schema for updating an existing dose record.
Response
Successful Response
Schema for returning dose information with computed fields.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
