Skip to main content
POST
/
user
/
patient
/
doses
/
{dose_id}
/
sign-off
Sign Off Dose
curl --request POST \
  --url https://api.decodahealth.com/user/patient/doses/{dose_id}/sign-off \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "patientId": "<string>",
  "name": "<string>",
  "providerId": "<string>",
  "sideEffects": "<string>",
  "administrationLocation": "<string>",
  "amount": 123,
  "unit": "AMPOULES",
  "lotNumber": "<string>",
  "stockId": "<string>",
  "noteId": "<string>",
  "doseDate": "2023-11-07T05:31:56Z",
  "comment": "<string>",
  "frequency": "<string>",
  "quantity": 123,
  "isUsedAsTemplate": true,
  "signedOffProviderId": "<string>",
  "signedOffDate": "2023-11-07T05:31:56Z",
  "provider": {
    "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

Response

Successful Response

DEPRECATED: Use DoseSummary for administration records. This schema is kept for backward compatibility.

​
id
string
required
​
createdDate
string<date-time>
required
​
patientId
string
required
​
name
string
required
​
providerId
string | null
​
sideEffects
string | null
​
administrationLocation
string | null
​
amount
number | null
​
unit
enum<string> | null
Available options:
AMPOULES,
APPLICATORS,
BOTTLES,
BOXES,
CAPSULES,
CUPS,
DOSES,
G_PER_ML,
GRAMS,
IU,
IU_PER_ML,
OUNCES,
FLUID_OUNCES,
KG,
KITS,
LITERS,
MCG,
MG,
MG_PER_ML,
ML,
MMOL,
MICROGRAM_PER_ML,
PACKS,
PAIRS,
PATCHES,
PERCENTAGE,
PIECES,
POUCHES,
ROLLS,
SACHETS,
SHEETS,
SPRAYS,
STRIPS,
SYRINGES,
TABLETS,
TABLETS_PER_DAY,
TESTS,
TUBES,
UNITS,
VIALS,
TREATMENTS,
SESSIONS,
PULSES,
JOULES,
CENTIMETERS,
THREAD_COUNT,
INJECTIONS,
WRINKLE_UNITS,
POUNDS,
FEET,
INCHES
​
lotNumber
string | null
​
stockId
string | null
​
noteId
string | null
​
doseDate
string<date-time> | null
​
comment
string | null
​
frequency
string | null
​
quantity
number | null
​
isUsedAsTemplate
boolean | null
​
signedOffProviderId
string | null
​
signedOffDate
string<date-time> | null
​
provider
UserTiny · object