Note Template
A note template is a template for creating notes.
The note template model
Properties
- Name
id
- Type
- string
- Description
Unique identifier for the note template.
- Name
object
- Type
- string
- Description
Always 'note_template'.
- Name
name
- Type
- string
- Description
Name of note template.
- Name
description
- Type
- string
- Description
Description of deocument.
- Name
published_version
- Type
- string
- Description
Note template version that is currently published. This is the note template version that is shown to the provider when they use the note template.
- Name
latest_version
- Type
- string
- Description
The latest note template version. This is the note template version that the admin will be viewing when they go to the note template builder in the Avon EMR. When the "publish" button is pressed in the Avon EMR UI or the /publish endpoint is called in the Avon API, the latest version will become the published version.
- Name
has_unpublished_changes
- Type
- boolean
- Description
If there are any changes in the 'note_template.latest_version' that are not in 'note_template.published_version.' If false, the contents of 'note_template.published_version' and 'note_template.latest_version' are the same.
- Name
usable_by
- Type
- object
- Description
- Who can use this note template.
- Name
share_by_default
- Type
- boolean
- Description
If true, notes created from this note template will be shared with all patients by default.
- Name
allow_member_change_default
- Type
- boolean
- Description
If true, providers and support team members will be able to change the default sharing settings for notes created from this note template.
- Name
created_by
- Type
- string
- Description
Creator of the note template.
- Name
created_at
- Type
- number
- Description
Timestamp (in ISO 8601 format) of when the note template was created.
- Name
last_updated_at
- Type
- number
- Description
Timestamp (in ISO 8601 format) of when the note template was last updated.
Response
{
"id": "ntmp_NOIYLBGOBNhSwTWCUzfu",
"object": "note_template",
"name": "Release of Medical Information",
"description": "This form allows us to collect consent from patients to retrieve their medical information from other providers.",
"published_version": "nver_1JtjV1QEY84Fv395Hl7h",
"latest_version": "nver_93tjV1QEY84Fv395Hl7h",
"has_unpublished_changes": true,
"usable_by": {
"usable_by_all": false,
"usable_by": {
"medical_centers":["mctr_XbvBirnEb1Mli1OLwqnM"],
"specializations": [],
"peer_groups": [],
"individuals": []
}
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": "2024-04-10T13:20:21.724Z",
"last_updated_at": "2024-04-10T13:20:21.724Z"
}
Create a note template
Creates a new note template and an unpublished note template version.
Required attributes
- Name
name
- Type
- string
- Description
Name of note template.
Optional attributes
- Name
description
- Type
- string
- Description
Description of note template.
- Name
usable_by
- Type
- object
- Description
- Defaults to usable by all. Who can use this note_template.
Response
{
"id": "ntmp_NOIYLBGOBNhSwTWCUzfu",
"object": "note_template",
"name": "Release of Medical Information",
"description": "This form allows us to collect consent from patients to retrieve their medical information from other providers.",
"published_version": "",
"latest_version": "",
"has_unpublished_changes": false,
"usable_by": {
"usable_by_all": false,
"usable_by": {
"medical_centers":["mctr_XbvBirnEb1Mli1OLwqnM"],
"specializations": [],
"peer_groups": [],
"individuals": []
}
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": "2024-04-10T13:20:21.724Z",
"last_updated_at": "2024-04-10T13:20:21.724Z"
}
Retrieve a note template
Retrieves the specified note template.
Response
{
"id": "ntmp_NOIYLBGOBNhSwTWCUzfu",
"object": "note_template",
"name": "Release of Medical Information",
"description": "This note template allows us to collect consent from patients to retrieve their medical information from other providers.",
"published_version": "fver_1JtjV1QEY84Fv395Hl7h",
"latest_version": "fver_93tjV1QEY84Fv395Hl7h",
"has_unpublished_changes": true,
"usable_by": {
"usable_by_all": false,
"usable_by": {
"medical_centers":["mctr_XbvBirnEb1Mli1OLwqnM"],
"specializations": [],
"peer_groups": [],
"individuals": []
}
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": "2024-04-10T13:20:21.724Z",
"last_updated_at": "2024-04-10T13:20:21.724Z"
}
Update a note template
Updates the specified note template object by setting the values of the parameters passed. Any other parameters not provided will not be modified.
Required attributes
Optional attributes
- Name
name
- Type
- string
- Description
Name of note template.
- Name
description
- Type
- string
- Description
Description of note template.
- Name
has_unpublished_changes
- Type
- boolean
- Description
If there are any changes in the 'form.latest_version' that are not in 'form.published_version.' If false, the contents of 'form.published_version' and 'form.latest_version' are the same.
- Name
usable_by
- Type
- object
- Description
- Who can use this note_template.
- Name
share_by_default
- Type
- boolean
- Description
If true, notes created from this note template will be shared with all patients by default.
- Name
allow_member_change_default
- Type
- boolean
- Description
If true, providers and support team members will be able to change the default sharing settings for notes created from this note template.
Response
{
"id": "ntmp_NOIYLBGOBNhSwTWCUzfu",
"object": "note_template",
"name": "Release of Medical Information",
"description": "This form allows us to collect consent from patients to retrieve their medical information from other providers.",
"published_version": "fver_1JtjV1QEY84Fv395Hl7h",
"latest_version": "fver_93tjV1QEY84Fv395Hl7h",
"has_unpublished_changes": true,
"usable_by": {
"usable_by_all": false,
"usable_by": {
"medical_centers":["mctr_XbvBirnEb1Mli1OLwqnM"],
"specializations": [],
"peer_groups": [],
"individuals": []
}
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": "2024-04-10T13:20:21.724Z",
"last_updated_at": "2024-04-10T13:20:21.724Z"
}
Publish a note template
Publishs the latest version of the specified note template by moving the note template version in 'latest_version' to 'published_version' and creating a new note template version in 'latest_version' that is a copy of the form version in 'published_version'.
Required attributes
Optional attributes
Response
{
"id": "ntmp_NOIYLBGOBNhSwTWCUzfu",
"object": "note_template",
"name": "Release of Medical Information",
"description": "This form allows us to collect consent from patients to retrieve their medical information from other providers.",
"published_version": "nver_93tjV1QEY84Fv395Hl7h",
"latest_version": "nver_009V1QEY84Fv395Hl7h",
"has_unpublished_changes": true,
"usable_by": {
"usable_by_all": false,
"usable_by": {
"medical_centers":["mctr_XbvBirnEb1Mli1OLwqnM"],
"specializations": [],
"peer_groups": [],
"individuals": []
}
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": "2024-04-10T13:20:21.724Z",
"last_updated_at": "2024-04-10T13:20:21.724Z"
}
List all note templates
Returns a list of all note templates.
Response
{
"object": "list",
"data": [
{
"id": "ntmp_NOIYLBGOBNhSwTWCUzfu",
"object": "note_template",
"name": "Release of Medical Information",
"description": "This form allows us to collect consent from patients to retrieve their medical information from other providers.",
"published_version": "nver_1JtjV1QEY84Fv395Hl7h",
"latest_version": "nver_93tjV1QEY84Fv395Hl7h",
"has_unpublished_changes": true,
"usable_by": {
"usable_by_all": false,
"usable_by": {
"medical_centers":["mctr_XbvBirnEb1Mli1OLwqnM"],
"specializations": [],
"peer_groups": [],
"individuals": []
}
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": "2024-04-10T13:20:21.724Z",
"last_updated_at": "2024-04-10T13:20:21.724Z"
},
]
}
Delete a note template
Deletes the specified note template.
Required attributes
Optional attributes
Response
{
"id": "ntmp_NOIYLBGOBNhSwTWCUzfu",
"object": "note_template",
"delete": true
}