Permissions needed: ACCESS_PATIENTS
\nWrites a QuickSOAP draft on the record, or updates the open one. Only the fields you send change. The draft shows up in the clinic's QuickSOAP, where the clinician reviews it and applies it to the record. This call doesn't change the record itself.
\nThe assessment field is spelled assesment.
Drafts on closed records aren't shown to the clinician, so check the record's status before writing.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "recordquickrecordbody", "description": "The QuickSOAP draft fields to write on a record. Send only the fields you want to change.", "schema": [ { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "", "example": "Daisy's Quick Record" }, { "name": "summary", "kind": "optional", "type": "string", "nullable": true, "description": "Applied to the record's summary notes.", "example": "Annual check, no concerns." }, { "name": "subjective", "kind": "optional", "type": "string", "nullable": true, "description": "Applied to the record's Subjective section.", "example": "Owner reports reduced appetite for two days." }, { "name": "objective", "kind": "optional", "type": "string", "nullable": true, "description": "Applied to the record's Objective section.", "example": "Mild dehydration, abdomen soft on palpation." }, { "name": "assesment", "kind": "optional", "type": "string", "nullable": true, "description": "Applied to the record's diagnosis. Spelled assesment.
Applied to the record's recommendations, which the Pet Parent can see.
", "example": "Offer small meals several times a day." }, { "name": "weight", "kind": "optional", "type": "number", "nullable": true, "description": "In the clinic's weight unit.", "example": 12.4 }, { "name": "temperature", "kind": "optional", "type": "number", "nullable": true, "description": "In the clinic's temperature unit.", "example": 38.6 }, { "name": "respiratory_rate", "kind": "optional", "type": "number", "nullable": true, "description": "", "example": 20 }, { "name": "heart_rate", "kind": "optional", "type": "number", "nullable": true, "description": "", "example": 96 } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "passport", "name": "passport", "kind": "optional", "type": "oauth2", "description": "Laravel passport oauth2 security.", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://digitail.test/oauth/authorize", "tokenUrl": "https://digitail.test/oauth/token", "refreshUrl": "https://digitail.test/oauth/token" } } }, { "id": "Bearer", "name": "Bearer", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful operation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "undefined", "description": "", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "D_xyKopSNMYEPm6DfERjm", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://developer.digitail.io/api/v1/records/{id}/quick-record \\\n --header 'accept: application/json'" }, { "id": "-PlWFLBp47b2Ct0H3jLsX", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://developer.digitail.io/api/v1/records/{id}/quick-record\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "QqmGV4qnvTzRNqG8S5z8a", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://developer.digitail.io/api/v1/records/{id}/quick-record\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "UgHY03yieZz5nlaan4erT", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://developer.digitail.io/api/v1/records/{id}/quick-record\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "D_xyKopSNMYEPm6DfERjm" }, "results": { "languages": [ { "id": "n8qYHGDb6HXGizT84EGbz", "language": "200", "code": "// successful operation\n\"\"" } ], "selectedLanguageId": "n8qYHGDb6HXGizT84EGbz" } }, "children": [ { "text": "" } ] }