clinical_note_templates_list

v1.0.0

Retrieve or search clinical note templates

Input

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

Output

{
  "type": "object",
  "description": "Paginated Result",
  "properties": {
    "data": {
      "type": "array",
      "description": "result data",
      "items": {
        "type": "object",
        "properties": {
          "archived": {
            "type": "boolean",
            "description": "Indicates that the doctor has soft-deleted this template, and will not use it for future appointments"
          },
          "clinical_note_fields": {
            "type": "array",
            "description": "clinical note fields",
            "items": {
              "type": "object",
              "description": "Array of field objects",
              "properties": {
                "allowed_values": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "archived": {
                  "type": "boolean",
                  "description": "Indicates that the field has been soft-deleted by the doctor"
                },
                "clinical_note_template": {
                  "type": "integer"
                },
                "data_type": {
                  "type": "string",
                  "description": "One of `\"\"`, `\"Checkbox\"`, `\"NullCheckbox\"`, `\"String\"`, `\"TwoStrings\"`, `\"FreeDraw\"`, `\"Photo\"`, `\"Header\"`, `\"Subheader\"`"
                },
                "name": {
                  "type": "string"
                },
                "required": {
                  "type": "boolean",
                  "description": "Indicates that a note should not be locked unless a value is provided for this field"
                }
              }
            }
          },
          "doctor": {
            "type": "string"
          },
          "id": {
            "type": "integer"
          },
          "is_onpatient": {
            "type": "boolean"
          },
          "is_persistent": {
            "type": "boolean",
            "description": "If this is true, this report will be the same across all notes"
          },
          "name": {
            "type": "string"
          },
          "order": {
            "type": "object",
            "description": "Order of templates",
            "properties": {
              "on_complete_note": {
                "type": "integer",
                "description": "Order of the template on complete notes"
              },
              "on_ipad": {
                "type": "integer",
                "description": "Order of the template on iPad"
              }
            }
          },
          "updated_at": {
            "type": "string"
          }
        }
      }
    },
    "next": {
      "type": "string",
      "description": "Next Paginated page"
    },
    "previous": {
      "type": "string",
      "description": "Previous paginated page"
    }
  }
}