Admin: Automated edit (via update-page on MediaWiki MCP Server)

2026-07-06T04:01:50Z

Automated edit (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 09:31, 6 July 2026
Line 112:		Line 112:
	* <code>facility</code>, <code>facility_organizations</code>, and <code>users</code> control sharing. Leave <code>facility</code> null for instance-wide templates.		* <code>facility</code>, <code>facility_organizations</code>, and <code>users</code> control sharing. Leave <code>facility</code> null for instance-wide templates.
	* Read <code>available_keys</code> to learn which sections a template carries without parsing <code>template_data</code>.		* Read <code>available_keys</code> to learn which sections a template carries without parsing <code>template_data</code>.

			{{Navbox definitions}}

	{{Related}}		{{Related}}

Admin: OHC identity seed

2026-07-04T22:44:47Z

OHC identity seed

New page

{{Doc header
|type=reference
|domain=definitions
|title=Questionnaire Response Template
|order=2
|introduced=3.0
|model=QuestionnaireResponseTemplate
|reference=References/Service Request
}}

A <code>QuestionnaireResponseTemplate</code> is a clinician's saved "favourite" or order set: a reusable, shareable bundle that pre-fills a [[References/Questionnaire Response|questionnaire response]] along with its medication requests and activity definitions. Reach for it when building authoring shortcuts that seed several clinical resources from one named template.

The Django model stores the template; the Pydantic resource specs define the <code>template_data</code> payload, its validation, and the read/write API schemas.

'''Source:'''

* Model: [<nowiki/>https://github.com/ohcnetwork/care/blob/develop/care/emr/models/questionnaire.py <code>care/emr/models/questionnaire.py</code>]
* Spec: [<nowiki/>https://github.com/ohcnetwork/care/blob/develop/care/emr/resources/questionnaire_response_template/spec.py <code>resources/questionnaire_response_template/spec.py</code>]

== Models ==

{| class="wikitable"
|-
! Model
! Purpose
|-
| <code>QuestionnaireResponseTemplate</code>
| A named template bundling pre-filled questionnaire answers, medication requests, and activity definitions, scoped to a facility/users/organizations
|}

<code>QuestionnaireResponseTemplate</code> extends [[References/Base models & conventions|<code>EMRBaseModel</code>]], the shared Care EMR base that provides <code>external_id</code>, audit fields, soft-delete, and <code>history</code>/<code>meta</code> JSON.

== <code>QuestionnaireResponseTemplate</code> fields ==

{| class="wikitable"
|-
! Field
! Type
! Notes
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=name|type=CharField(255)|notes=Display name shown when picking a template}}
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=description|type=TextField|notes=<code>default=""</code>}}
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=template_data|type=JSONField|notes=<code>default=dict</code>. The structured payload; shape defined by <code>TemplateData</code> (see [[#templatedata-shape}}
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=facility|type=FK → Facility|notes=<code>CASCADE</code>, nullable. Owning facility; instance-wide when null}}
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=questionnaire|type=FK → Questionnaire|notes=<code>CASCADE</code>, nullable, <code>default=None</code>. The questionnaire the template targets, if any}}
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=facility_organizations|type=ArrayField[int]|notes=<code>default=list</code>. Facility-organization ids the template is shared with}}
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=users|type=ArrayField[int]|notes=<code>default=list</code>. User ids the template is shared with}}
{{Field|model=QuestionnaireResponseTemplate|section=QuestionnaireResponseTemplate fields|name=available_keys|type=ArrayField[CharField(255)]|notes=<code>default=list</code>. Platform-maintained: the populated top-level keys of <code>template_data</code>, recomputed on every write. Don't set it directly}}
|}

== <code>TemplateData</code> shape ==

<code>template_data</code> is an opaque <code>JSONField</code> on the model; the spec (<code>resources/questionnaire_response_template/spec.py</code>) gives it this structure. Every section is optional, and <code>available_keys</code> records which ones a given template carries.

<syntaxhighlight lang="text">TemplateData {
medication_request: list[MedicationRequestTemplateSpec] | None
questionnaire: list[QuestionnaireAnswer] | None
activity_definition: list[ActivityDefinitionTemplateSpec] | None
meta: dict | None
}

QuestionnaireAnswer { question_id: str, answer: dict, meta: dict }

MedicationRequestTemplateSpec # extends the medication request write spec
+ requested_product: str | None # validated against ProductKnowledge.slug

ActivityDefinitionTemplateSpec {
slug: str # validated against ActivityDefinition.slug
service_request: ServiceRequestUpdateSpec
}</syntaxhighlight>
See [[References/Medication Request]], [[References/Activity Definition]], and [[References/Service Request]] for the embedded specs.

== Resource specs (API schema) ==

All specs extend <code>EMRResource</code> (<code>resources/base.py</code>).

{| class="wikitable"
|-
! Spec class
! Role
! Notes
|-
| <code>QuestionnaireResponseTemplateBaseSpec</code>
| shared
| <code>__model__ = QuestionnaireResponseTemplate</code>; <code>id</code> (<code>UUID4?</code>), <code>template_data</code> (<code>TemplateData</code>), <code>name</code>, <code>description</code> (<code>= ""</code>)
|-
| <code>QuestionnaireResponseTemplateCreateSpec</code>
| write · create
| Adds <code>questionnaire</code> (slug <code>str?</code>), <code>facility</code> (<code>UUID4?</code>), <code>users</code> (<code>list[str]</code>), <code>facility_organizations</code> (<code>list[UUID4]</code>). Requires a <code>facility</code> whenever <code>facility_organizations</code> are given; resolves the questionnaire by slug and the facility by external id; recomputes <code>available_keys</code>
|-
| <code>QuestionnaireResponseTemplateUpdateSpec</code>
| write · update
| <code>users</code>, <code>facility_organizations</code>; recomputes <code>available_keys</code>. Cannot change <code>facility</code>/<code>questionnaire</code>
|-
| <code>QuestionnaireResponseTemplateReadSpec</code>
| read · list
| Adds <code>created_date</code>/<code>modified_date</code>
|-
| <code>QuestionnaireResponseTemplateRetrieveSpec</code>
| read · detail
| Expands <code>users</code> (<code>UserSpec</code> via cache) and <code>facility_organizations</code> (<code>FacilityOrganizationReadSpec</code>), plus <code>created_by</code>/<code>updated_by</code>
|}

=== Validation and server-maintained behaviour ===

* <code>validate_facility</code> (<code>model_validator(after)</code> on create) rejects facility organizations that have no facility.
* <code>perform_extra_deserialization</code> derives <code>available_keys</code> on every create and update from the <code>template_data</code> keys whose value is non-empty. Clients don't set it.
* Before save, the embedded <code>requested_product</code> and activity-definition <code>slug</code> are checked to exist against <code>ProductKnowledge</code> and <code>ActivityDefinition</code>.

== API integration notes ==

* This is a Care-specific authoring convenience, not a FHIR resource, so it has no FHIR mapping.
* <code>facility</code>, <code>facility_organizations</code>, and <code>users</code> control sharing. Leave <code>facility</code> null for instance-wide templates.
* Read <code>available_keys</code> to learn which sections a template carries without parsing <code>template_data</code>.

{{Related}}

References/Questionnaire Response Template - Revision history

Admin: Automated edit (via update-page on MediaWiki MCP Server)

Admin: OHC identity seed