Care Plan Template

A care plan template is a template for creating care plans.

The care plan template model

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the care plan template.

  • Name
    object
    Type
    string
    Description

    Always 'care_plan_template'.

  • Name
    name
    Type
    string
    Description

    Name of care plan template.

  • Name
    description
    Type
    string
    Description

    Description of deocument.

  • Name
    published_version
    Type
    string
    Description

    Care plan template version that is currently published. This is the care plan template version that is shown to the provider when they use the care plan template.

  • Name
    latest_version
    Type
    string
    Description

    The latest care plan template version. This is the care plan template version that the admin will be viewing when they go to the care plan 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 'care_plan_template.latest_version' that are not in 'care_plan_template.published_version.' If false, the contents of 'care_plan_template.published_version' and 'care_plan_template.latest_version' are the same.

  • Name
    usable_by
    Type
    object
    Description
    Who can use this care plan template.
  • Name
    share_by_default
    Type
    boolean
    Description

    If true, care plans created from this care plan 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 care plans created from this care plan template.

  • Name
    created_by
    Type
    string
    Description

    Creator of the care plan template.

  • Name
    created_at
    Type
    number
    Description

    Timestamp (in ISO 8601 format) of when the care plan template was created.

  • Name
    last_updated_at
    Type
    number
    Description

    Timestamp (in ISO 8601 format) of when the care plan template was last updated.

Response

{
    "id": "ctmp_NOIYLBGOBNhSwTWCUzfu",
    "object": "care_plan_template",
    "name": "Diabetes Self-Management and Lifestyle Support Plan",
    "description": "A structured care plan focused on helping the patient manage blood sugar, improve medication adherence, build sustainable nutrition and exercise habits, monitor symptoms, and reduce the risk of diabetes-related complications.",
    "published_version": "ctmv_1JtjV1QEY84Fv395Hl7h",
    "latest_version": "ctmv_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"
}
POST/v2/care_plan_templates

Create a care plan template

Creates a new care plan template and an unpublished care plan template version.

Required attributes

  • Name
    name
    Type
    string
    Description

    Name of care plan template.

Optional attributes

  • Name
    description
    Type
    string
    Description

    Description of care plan template.

  • Name
    usable_by
    Type
    object
    Description
    Defaults to usable by all. Who can use this care_plan_template.

Response

 {
    "id": "ctmp_NOIYLBGOBNhSwTWCUzfu",
    "object": "care_plan_template",
    "name": "Diabetes Self-Management and Lifestyle Support Plan",
    "description": "A structured care plan focused on helping the patient manage blood sugar, improve medication adherence, build sustainable nutrition and exercise habits, monitor symptoms, and reduce the risk of diabetes-related complications.",
    "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"
}
GET/v2/forms/:id

Retrieve a care plan template

Retrieves the specified care plan template.

Response


{
   "id": "ctmp_NOIYLBGOBNhSwTWCUzfu",
   "object": "care_plan_template",
   "name": "Diabetes Self-Management and Lifestyle Support Plan",
   "description": "This care plan template allows us to collect consent from patients to retrieve their medical information from other providers.",
   "published_version": "ctmv_1JtjV1QEY84Fv395Hl7h",
   "latest_version": "ctmv_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"
}
POST/v2/forms/:id

Update a care plan template

Updates the specified care plan 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 care plan template.

    • Name
      description
      Type
      string
      Description

      Description of care plan 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 care_plan_template.
    • Name
      share_by_default
      Type
      boolean
      Description

      If true, care plans created from this care plan 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 care plans created from this care plan template.

    Response

    
{
    "id": "ctmp_NOIYLBGOBNhSwTWCUzfu",
    "object": "care_plan_template",
    "name": "Diabetes Self-Management and Lifestyle Support Plan",
    "description": "A structured care plan focused on helping the patient manage blood sugar, improve medication adherence, build sustainable nutrition and exercise habits, monitor symptoms, and reduce the risk of diabetes-related complications.",
    "published_version": "ctmv_1JtjV1QEY84Fv395Hl7h",
    "latest_version": "ctmv_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"
}
    POST/v2/care_plan_templates/:id/publish

    Publish a care plan template

    Publishs the latest version of the specified care plan template by moving the care plan template version in 'latest_version' to 'published_version' and creating a new care plan template version in 'latest_version' that is a copy of the form version in 'published_version'.

    Required attributes

      Optional attributes

        Response

        
{
    "id": "ctmp_NOIYLBGOBNhSwTWCUzfu",
    "object": "care_plan_template",
    "name": "Diabetes Self-Management and Lifestyle Support Plan",
    "description": "A structured care plan focused on helping the patient manage blood sugar, improve medication adherence, build sustainable nutrition and exercise habits, monitor symptoms, and reduce the risk of diabetes-related complications.",
    "published_version": "ctmv_93tjV1QEY84Fv395Hl7h",
    "latest_version": "ctmv_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"
}
        GET/v2/care_plan_templates

        List all care plan templates

        Returns a list of all care plan templates.

        Response

        {
  "object": "list",
  "data": [
    {
        "id": "ctmp_NOIYLBGOBNhSwTWCUzfu",
        "object": "care_plan_template",
        "name": "Diabetes Self-Management and Lifestyle Support Plan",
        "description": "A structured care plan focused on helping the patient manage blood sugar, improve medication adherence, build sustainable nutrition and exercise habits, monitor symptoms, and reduce the risk of diabetes-related complications.",
        "published_version": "ctmv_1JtjV1QEY84Fv395Hl7h",
        "latest_version": "ctmv_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/v2/forms/:id

        Delete a care plan template

        Deletes the specified care plan template.

        Required attributes

          Optional attributes

            Response

            {
    "id": "ctmp_NOIYLBGOBNhSwTWCUzfu",
    "object": "care_plan_template",
    "delete": true
}