custom_demographics_read

v1.0.0

Retrieve an existing custom demographics field

Input

{
  "type": "object",
  "properties": {
    "doctor": {
      "type": "integer"
    },
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Output

{
  "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."
    }
  }
}