Note Template Version

The note template version contains the actual contents for the note template. Each note contains 'note_template_version' field, which tells you exactly the contents of the note template when it was used, even if the contents are now modified.

The note template version model

Properties

Name
id
Type
string
Description
Unique identifier for the note template version.
Name
object
Type
string
Description
Always 'note_template_version'.
Name
note_template
Type
string
Description
Note template this note template version belongs to.
Name
sections
Type
array of objects
Description
List of sections in this note template version.
Name
created_at
Type
number
Description
Timestamp (in ISO 8601 format) of when the note template version was created.
Name
last_updated_at
Type
number
Description
Timestamp (in ISO 8601 format) of when the note template version was last updated.

Response

{
    "id": "ntmv_U8xtAULYUrX7GVsTKePy",
    "object": "note_template_version",
    "note_template": "ntmp_NOIYLBGOBNhSwTWCUzfu",
    "sections": [{
      "id": "ntsc_1JtjV1QEY84Fv395Hl7h",
      "name": "Section 1",
      "conditions": [
        [
          {
            "field": "nqst_3951JtjV1QEY84FvHl7h",
            "condition": "equal_to",
            "value": "Yes"
          }
        ]
      ],
      "questions": [
        {
          "id": "nqst_U8xtAULYUrX7GVsTKePy",
          "object": "note_template_question",

          "name": "What is your name?",
          "type": "short_answer",
          "show_on_summary_card": true,
          "required": true,
          "conditions": [
            [
              {
                "field": "nqst_3951JtjV1QEY84FvHl7h",
                "condition": "equalTo",
                "value": "Yes"
              }
            ]
          ]
        }
      ]
    }],
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}

GET/v2/note_template_versions/:id

Retrieve a note template version

Retrieves the specified note template version.

Response

{
   "id": "ntmv_U8xtAULYUrX7GVsTKePy",
   "object": "note_template_version",
   "note_template": "ntmp_NOIYLBGOBNhSwTWCUzfu",
   "sections": [{
     "id": "ntsc_1JtjV1QEY84Fv395Hl7h",
     "name": "Section 1",
     "conditions": [
       [
         {
           "field": "nqst_3951JtjV1QEY84FvHl7h",
           "condition": "equal_to",
           "value": "Yes"
         }
       ]
     ],
     "questions": [
       {
         "id": "nqst_U8xtAULYUrX7GVsTKePy",
         "object": "note_template_question",

         "name": "What is your name?",
         "type": "short_answer",
         "show_on_summary_card": true,
         "required": true,
         "conditions": [
           [
             {
               "field": "nqst_3951JtjV1QEY84FvHl7h",
               "condition": "equalTo",
               "value": "Yes"
             }
           ]
         ]
       }
     ]
   }],
   "created_at": "2024-04-10T13:20:21.724Z",
   "last_updated_at": "2024-04-10T13:20:21.724Z"
}

POST/v2/note_template_versions/:id

Update a note template version

Updates the specified note template version object by setting the values of the parameters passed. Any other parameters not provided will not be modified. The note template version can only be updated if it's in the 'latest_version' field of the associated form. A note template version cannot be updated once it's been moved to the 'published_version' field of the associated form.

Required attributes

Optional attributes

Name
sections
Type
array of strings
Description
All the section in the note template version.

Response

{
    "id": "ntmv_U8xtAULYUrX7GVsTKePy",
    "object": "note_template_version",
    "note_template": "ntmp_NOIYLBGOBNhSwTWCUzfu",
    "sections": [{
      "id": "ntsc_1JtjV1QEY84Fv395Hl7h",
      "name": "Section 1",
      "conditions": [
        [
          {
            "field": "nqst_3951JtjV1QEY84FvHl7h",
            "condition": "equal_to",
            "value": "Yes"
          }
        ]
      ],
      "questions": [
        {
          "id": "nqst_U8xtAULYUrX7GVsTKePy",
          "object": "note_template_question",

          "name": "What is your name?",
          "type": "short_answer",
          "show_on_summary_card": true,
          "required": true,
          "conditions": [
            [
              {
                "field": "nqst_3951JtjV1QEY84FvHl7h",
                "condition": "equalTo",
                "value": "Yes"
              }
            ]
          ]
        }
      ]
    }],
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
}

GET/v2/note_template_versions

List all note template versions

Returns a list of all note template versions.

Optional query parameters

Name
note_template
Type
string
Description
Note template to filter by.

Response

{
  "object": "list",
  "data": [{
    "id": "ntmv_U8xtAULYUrX7GVsTKePy",
    "object": "note_template_version",
    "note_template": "ntmp_NOIYLBGOBNhSwTWCUzfu",
    "sections": [{
      "id": "ntsc_1JtjV1QEY84Fv395Hl7h",
      "name": "Section 1",
      "conditions": [
        [
          {
            "field": "nqst_3951JtjV1QEY84FvHl7h",
            "condition": "equal_to",
            "value": "Yes"
          }
        ]
      ],
      "questions": [
        {
          "id": "nqst_U8xtAULYUrX7GVsTKePy",
          "object": "note_template_question",

          "name": "What is your name?",
          "type": "short_answer",
          "show_on_summary_card": true,
          "required": true,
          "conditions": [
            [
              {
                "field": "nqst_3951JtjV1QEY84FvHl7h",
                "condition": "equalTo",
                "value": "Yes"
              }
            ]
          ]
        }
      ]
    }],
    "created_at": "2024-04-10T13:20:21.724Z",
    "last_updated_at": "2024-04-10T13:20:21.724Z"
  }]
}