Conversation
ruipbatista
force-pushed
the
custom-chart-sections
branch
from
e2d00c6 to
cf78460
Compare
| ### `templates/my_section.html` | ||
|
|
||
| ```html | ||
| <ul> | ||
| {% for item in items %} | ||
| <li>{{ item.title }}</li> | ||
| {% empty %} | ||
| <li>No items on record.</li> | ||
| {% endfor %} | ||
| </ul> | ||
| ``` | ||
|
|
There was a problem hiding this comment.
I noticed the web preview didnt run so when I locally checked this out to see the page I got Liquid Exception: Liquid syntax error (line 141): Unknown tag 'empty' in /Users/reba_magier/Canvas/repos/documentation/collections/_sdk/handlers/patient-chart-summary-custom-section-handler.md
and claude did this because it said "Wrapped the HTML template block in {% raw %}...{% endraw %} so Jekyll's Liquid parser stops trying to evaluate the Django template tags ({% for %}, {% empty %}, {% endfor %}) inside the code sample."
| ### `templates/my_section.html` | |
| ```html | |
| <ul> | |
| {% for item in items %} | |
| <li>{{ item.title }}</li> | |
| {% empty %} | |
| <li>No items on record.</li> | |
| {% endfor %} | |
| </ul> | |
| ``` | |
| ### `templates/my_section.html` | |
| {% raw %} | |
| ```html | |
| <ul> | |
| {% for item in items %} | |
| <li>{{ item.title }}</li> | |
| {% empty %} | |
| <li>No items on record.</li> | |
| {% endfor %} | |
| </ul> |
{% endraw %}
|
|
||
| ## Overview | ||
|
|
||
| Custom chart summary sections are registered through [`PatientChartSummaryConfiguration`](/sdk/patient-chart-summary-configuration-effect/) and served by a `PatientChartSummaryCustomSectionHandler` subclass. Each handler is responsible for exactly one section, identified by its `SECTION_KEY`. |
There was a problem hiding this comment.
What happens if someone were to try to create a handler in one plugin but then have a different plugin installed for the PatientChartSummaryConfiguration? Is the name of the custom section being validated in the same plugin or is it another plugins model that we are saving the custom sections to?
| - **`handle()`** | ||
| Called when Canvas requests the content for this section. Must return a list containing a single `PatientChartSummaryCustomSection` effect. | ||
|
|
||
| ## Registering the Section |
There was a problem hiding this comment.
| ## Registering the Section | |
| ## Configuring Chart Summary Sections |
|
|
||
| ## Registering the Section | ||
|
|
||
| A custom section handler alone is not enough — the section must also be included in the chart summary layout. Use `PatientChartSummaryConfiguration` to declare which sections appear in the chart summary and in what order. |
There was a problem hiding this comment.
I would link to sdk/layout-effect/#patient-summary as a reference for the other sections you can configure with this effect
| ] | ||
| ``` | ||
|
|
||
| Both handlers must be registered in `CANVAS_MANIFEST.json`. |
There was a problem hiding this comment.
I would move this to the ## Overview section instead after you call out the 2 handlers
| entries = ( | ||
| CommandMetadata.objects.filter( | ||
| key="my_section", | ||
| command__patient__id=self.target, |
There was a problem hiding this comment.
This makes me think in the## Creating a Custom Section Handler section we should call out what the self.target and self.context stuff the user has in this handler specifically
| class MySectionHandler(PatientChartSummaryCustomSectionHandler): | ||
| SECTION_KEY = "my_section" | ||
|
|
||
| def handle(self) -> list[Effect]: |
There was a problem hiding this comment.
Lets add doc string to this example of what this handle is actually doing for the end user. Love the example to use CommandMetadata since customers want to be able to visualize those values
| ## Accessing Patient Data | ||
|
|
||
| The patient key is available via `self.target`. Use it to scope database queries to the current patient. | ||
|
|
||
| ```python | ||
| from canvas_sdk.v1.data.patient import Patient | ||
|
|
||
| patient = Patient.objects.get(id=self.target) | ||
| ``` |
There was a problem hiding this comment.
Oh its down here. Yeah lets move it to the other section I commented about and also include the self.context
| A unique string identifier for the section. Must match the key passed to `PatientChartSummaryConfiguration.CustomSection`. Omitting or leaving it empty will raise an `ImproperlyConfigured` error when the plugin loads. | ||
|
|
||
| - **`handle()`** | ||
| Called when Canvas requests the content for this section. Must return a list containing a single `PatientChartSummaryCustomSection` effect. |
There was a problem hiding this comment.
Link to the effect documentation here
| hidden: false | ||
| --- | ||
|
|
||
| ## Overview |
There was a problem hiding this comment.
Can we add a link in /sdk/layout-effect/#patient-summary to this page (or the handler page?) so that not only you can configure builtin sections, you can define custom ones
| | `content` | required (if `url` is not provided) | `str \| None` | Inline HTML content to render in the section. Mutually exclusive with `url`. | | ||
| | `url` | required (if `content` is not provided) | `str \| None` | URL of the page to load in the section iframe. Mutually exclusive with `content`. | | ||
| | `icon` | required (if `icon_url` is not provided) | `str \| None` | Text or emoji displayed as the section icon when collapsed. Mutually exclusive with `icon_url`. | | ||
| | `icon_url` | required (if `icon` is not provided) | `str \| None` | URL of an image to use as the section icon when collapsed. Mutually exclusive with `icon`. | |
There was a problem hiding this comment.
extra character in the Type column
| # Serve content from a hosted URL | ||
| PatientChartSummaryCustomSection( | ||
| url="/plugin-io/api/my_plugin/my-section", | ||
| icon_url="/plugin-io/api/my_plugin/icon.png", |
There was a problem hiding this comment.
the icon is really a path not a url
2 participants
https://canvasmedical.atlassian.net/browse/KOALA-3081