Note Template Version Section

The note template version sections contains information about a section in a note template version.

The note template version section model

Properties

Name
id
Type
string
Description
Unique identifier for the note template version section.
Name
object
Type
string
Description
Always 'note_template_section'.
Name
note_template
Type
string
Description
Note template that this note template version section belongs to.
Name
note_template_version
Type
string
Description
Note template version that this note template version section belongs to.
Name
name
Type
string
Description
Name of the note template version section.
Name
questions
Type
string
Description
List of questions is this note template version section.
Name
conditions
Type
2D array of objects
Description
Set of conditions that have to be met for this note template version section to be visible. If no conditions are passed, this note template version section will always be visible. The inner array is a set of conditions that are ANDed together whereas the outer array is a set of conditions that are ORed together. For example, if you want this note template version section to be visible if the patient selects either option 1 or option 2, you would pass:
```
[
  [
    {
      "field": "opt_1",
      "condition": "equalTo",
      "value": true
    }
  ],
  [
    {
      "field": "opt_2",
      "condition": "equalTo",
      "value": true
    }
  ]
]
```
If you want this note template version section to be visible if the patient selects option 1 and option 2, you would pass:
```
[
  [
    {
      "field": "opt_1",
      "condition": "equalTo",
      "value": true
    },
    {
      "field": "opt_2",
      "condition": "equalTo",
      "value": true
    }
  ]
]
```

Response

{
    "id": "ntsc_U8xtAULYUrX7GVsTKePy",
    "object": "note_template_section",

    "note_template": "ntmp_1JtjV1QEY84Fv395Hl7h",
    "note_template_version": "ntmv_1JtjV1QEY84Fv395Hl7h",

    "name": "Section 1",
    "questions": ["nqst_1JtjV1QEY84Fv395Hl7h"],
    "conditions": [
      [
        {
          "field": "nqst_3951JtjV1QEY84FvHl7h",
          "condition": "equalTo",
          "value": "Yes"
        }
      ]
    ]
}

POST/v2/note_templates/:id/sections

Create a note template version section

Creates a new note template version section.

Required attributes

Name
note_template
Type
string
Description
Note template that this note template version section belongs to.

Optional attributes

Name
note_tempate_version
Type
string
Description
Note template version that this note template version section belongs to.
Name
name
Type
string
Description
Name of the note template version section.
Name
questions
Type
string
Description
List of questions is this note template version section.
Name
conditions
Type
2D array of objects
Description
Set of conditions that have to be met for this note template version section to be visible. If no conditions are passed, this note template version section will always be visible. The inner array is a set of conditions that are ANDed together whereas the outer array is a set of conditions that are ORed together. For example, if you want this note template version section to be visible if the patient selects either option 1 or option 2, you would pass:
```
[
  [
    {
      "field": "opt_1",
      "condition": "equalTo",
      "value": true
    }
  ],
  [
    {
      "field": "opt_2",
      "condition": "equalTo",
      "value": true
    }
  ]
]
```
If you want this note template version section to be visible if the patient selects option 1 and option 2, you would pass:
```
[
  [
    {
      "field": "opt_1",
      "condition": "equalTo",
      "value": true
    },
    {
      "field": "opt_2",
      "condition": "equalTo",
      "value": true
    }
  ]
]
```

Response

 {
    "id": "ntsc_U8xtAULYUrX7GVsTKePy",
    "object": "note_template_section",

    "note_template": "ntmp_1JtjV1QEY84Fv395Hl7h",
    "note_template_version": "ntmv_1JtjV1QEY84Fv395Hl7h",

    "name": "Section 1",
    "questions": ["nqst_1JtjV1QEY84Fv395Hl7h"],
    "conditions": [
      [
        {
          "field": "nqst_3951JtjV1QEY84FvHl7h",
          "condition": "equalTo",
          "value": "Yes"
        }
      ]
    ]
}

GET/v2/note_templates/:id/sections/:section

Retrieve a note template version section

Retrieves the specified note template version section.

Response


{
  "id": "ntsc_U8xtAULYUrX7GVsTKePy",
   "object": "note_template_section",

   "note_template": "ntmp_1JtjV1QEY84Fv395Hl7h",
   "note_template_version": "ntmv_1JtjV1QEY84Fv395Hl7h",

   "name": "Section 1",
   "questions": ["nqst_1JtjV1QEY84Fv395Hl7h"],
   "conditions": [
     [
       {
         "field": "nqst_3951JtjV1QEY84FvHl7h",
         "condition": "equalTo",
         "value": "Yes"
       }
     ]
   ]
}

POST/v2/note_templates/:id/sections/:section

Update a note template version section

Updates the specified note template version section object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

Optional attributes

Name
note_template
Type
string
Description
Note template that this note template version section belongs to.
Name
note_tempate_version
Type
string
Description
Note template version that this note template version section belongs to.
Name
name
Type
string
Description
Name of the note template version section.
Name
questions
Type
string
Description
List of questions is this note template version section.
Name
conditions
Type
2D array of objects
Description
Set of conditions that have to be met for this note template version section to be visible. If no conditions are passed, this note template version section will always be visible. The inner array is a set of conditions that are ANDed together whereas the outer array is a set of conditions that are ORed together. For example, if you want this note template version section to be visible if the patient selects either option 1 or option 2, you would pass:
```
[
  [
    {
      "field": "opt_1",
      "condition": "equalTo",
      "value": true
    }
  ],
  [
    {
      "field": "opt_2",
      "condition": "equalTo",
      "value": true
    }
  ]
]
```
If you want this note template version section to be visible if the patient selects option 1 and option 2, you would pass:
```
[
  [
    {
      "field": "opt_1",
      "condition": "equalTo",
      "value": true
    },
    {
      "field": "opt_2",
      "condition": "equalTo",
      "value": true
    }
  ]
]
```

Response


{
    "id": "ntsc_U8xtAULYUrX7GVsTKePy",
    "object": "note_template_section",

    "note_template": "ntmp_1JtjV1QEY84Fv395Hl7h",
    "note_template_version": "ntmv_1JtjV1QEY84Fv395Hl7h",

    "name": "Section 1",
    "questions": ["nqst_1JtjV1QEY84Fv395Hl7h"],
    "conditions": [
      [
        {
          "field": "nqst_3951JtjV1QEY84FvHl7h",
          "condition": "equalTo",
          "value": "Yes"
        }
      ]
    ]
}

GET/v2/note_templates/:id/sections

List all note template version sections

Returns a list of all note template version sections.

Optional query parameters

Name
note_template
Type
string
Description
Note template to filter by.
Name
note_template_version
Type
string
Description
Note template version to filter by.

Response

{
  "object": "list",
  "data": [
    {
        "id": "ntsc_U8xtAULYUrX7GVsTKePy",
        "object": "note_template_section",

        "note_template": "ntmp_1JtjV1QEY84Fv395Hl7h",
        "note_template_version": "ntmv_1JtjV1QEY84Fv395Hl7h",

        "name": "Section 1",
        "questions": ["nqst_1JtjV1QEY84Fv395Hl7h"],
        "conditions": [
          [
            {
              "field": "nqst_3951JtjV1QEY84FvHl7h",
              "condition": "equalTo",
              "value": "Yes"
            }
          ]
        ]
    },
  ]
}

DELETE/v2/note_templates/:id/sections/:section

Delete a note template version section

Deletes the specified note template version section.

Required attributes

Optional attributes

Response

{
    "id": "ntsc_U8xtAULYUrX7GVsTKePy",
    "object": "note_template_section",
    "delete": true
}