custom_demographics_list

v1.0.0

Retrieve or search custom demographics fields

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",
        "required": [
          "doctor",
          "name"
        ],
        "properties": {
          "allowed_values": {
            "type": "string",
            "description": "Allowed values if needed. Values must be separated by comma `,`"
          },
          "archived": {
            "type": "boolean",
            "description": "Indicates that the object has been soft-deleted, and should not be used"
          },
          "description": {
            "type": "string"
          },
          "doctor": {
            "type": "integer"
          },
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "template_name": {
            "type": "string",
            "description": "Custom Patient Demographics with `template_name` set can be inserted into clinical notes via Form Builder. Only letters (a-z or A-Z), numbers (0-9) or underscore(_) are allowed for template name."
          }
        }
      }
    },
    "next": {
      "type": "string",
      "description": "Next Paginated page"
    },
    "previous": {
      "type": "string",
      "description": "Previous paginated page"
    }
  }
}