amendments_list

v1.0.0

Retrieve or search patient amendments. You can only interact with amendments created by your API application

Input

{
  "type": "object",
  "properties": {
    "appointment": {
      "type": "integer"
    },
    "cursor": {
      "type": "string",
      "description": "The pagination cursor value."
    },
    "doctor": {
      "type": "integer"
    },
    "page_size": {
      "type": "integer",
      "description": "Number of results to return per page."
    },
    "patient": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Paginated Result",
  "properties": {
    "data": {
      "type": "array",
      "description": "result data",
      "items": {
        "type": "object",
        "required": [
          "patient",
          "doctor",
          "amendment_name",
          "amendment_file"
        ],
        "properties": {
          "amendment_file": {
            "type": "string",
            "description": "A PDF file containing the amended information for the patient's record"
          },
          "amendment_name": {
            "type": "string"
          },
          "appointment": {
            "type": "integer",
            "description": "ID of the appointment to which the amendment applies, if any. If present, the `amendment_file` will be appended to the clinical note for this appointment."
          },
          "comments": {
            "type": "string"
          },
          "doctor": {
            "type": "integer",
            "description": "ID of the doctor who owns the amendment"
          },
          "id": {
            "type": "integer"
          },
          "patient": {
            "type": "integer",
            "description": "ID of the patient to whom the amendment applies"
          }
        }
      }
    },
    "next": {
      "type": "string",
      "description": "Next Paginated page"
    },
    "previous": {
      "type": "string",
      "description": "Previous paginated page"
    }
  }
}