Reference for writing HTML for the Html_Form_Entry_Module

Tag Reference

<code>

<encounterDate>

Data entry widget for recording encounter date. Along with encounterLocation and encounterProvider, encounterDate should be present on every HTML form.

Attributes

defaultSpecifies: default value for encounterDate widget.
- OPTIONAL
- Example: <encounterDate default="today"/>
- Value: "today", "now", or ?????
- Default: None
showTime: The showTime attribute determines if the encounterDate widget is date-only or date and time.
- OPTIONAL
- Example: <encounterDate showTime="true"/>
- Value: "true" or "false"
- Default: False - Widget is date-only

Example Usage <encounterDate/> <!- an initially-blank date widget ->

<encounterLocation>

Data entry widget for recording location of the encounter. Along with encounterDate and encounterProvider, encounterLocation should be present on every HTML form.

Attributes

defaultSets: default value for the widget.
- OPTIONAL
- Example: <encounterLocation default="2"/>
- Value: Location ID or Location
- NameDefault: None
order: Determines which locations appear in the list, and specifies the order in which they appear.
- OPTIONAL
- Example: <encounterLocation order="2,7,4"/>
- Value: Comma separated list of Location IDs or Location Names
- Default: All locations in alphabetical order

Example Usage <encounterLocation/> <!- a list of all locations, sorted alphabetically by name ->

<encounterProvider>

Data entry widget for recording provider for the encounter. Along with encounterDate and encounterLocation, encounterProvider should be present on every HTML form.

Attributes

defaultSets: default value for the widget.[OPTIONAL]
- OPTIONAL
- Example: <encounterProvider default="djaz"/>
- Value: Username or UserID
- Default: None
roleFilters: the list of users to only those with the specified role. [OPTIONAL]
- OPTIONAL
- Example: <encounterProvider role="Provider"/>
- Value: Any valid role
- Default: None - List includes all users.

Example Usage <encounterProvider/> <!- a list of all users ->

<enrollInProgram>

Enrolls a patient in a program when the form is submitted. This only happens when the form is first entered--nothing happens when the form is edited or deleted.

Specifics about this enrollment behavior:

If the patient is already in the program on that date, nothing changes
If the patient is registered in the program after that date, then the patient's enrollment date will be moved back to the date of this encounter
Otherwise, the patient is enrolled as requested

Attributes

programID
- ID of the program in which the patient is to be enrolled.
- REQUIRED
- Example: <enrollInProgram programId="1"/>
- Value: Any valid program ID.
- Default: None.

<excludeIf>

A tag that optionally exclude all its content based on evaluating a logic token or a velocity expression. This tag has to only contain either a logic test or a velocity test.

Attributes

logicTest A logic expression represents a logic test.
- OPTIONAL
- Example: <excludeIf logicTest="GENDER = F"/>
- A logic test to see if the patient's gender is female
velocityTest A velocity expression represents a velocity test.
- OPTIONAL
- Example: <excludeIf velocityTest=""$patient.gender" == "F" "/>
- A velocity test to see if the patient's gender is female.

<htmlform>

Top-level tag that defines a form. A form must be wrapped in an htmlform tag.

Example Usage <htmlform>

 <table border="0" width="100%">
 <tr><td><includeIf logicTest="GENDER = F">This  shows a logic test for a woman</includeIf> </td></tr>

<tr><td><includeIf  velocityTest=""$patient.gender" == "F" ">This shows a velocity test  for a woman</includeIf> </td></tr>

<tr><td><excludeIf logicTest="GENDER =  F">This won't show for a logic test for a woman</excludeIf>  </td></tr>

<tr><td><excludeIf  velocityTest=""$patient.gender" == "F" ">This won't show for a  velocity test for a woman</excludeIf> </td></tr>

</table>
 </htmlform>

<includeIf>

See <excludeIf>

[edit]

<lookup>

Allows you to evaluation of velocity expressions.

The variables you have access to in the velocity context are:patientthepatient objectyou're entering the form forlocalethe authenticated user's localepatientIdentifiersMap<String, List<String>> of identifierType.name -> all identifiers of that type[edit]

Attributes

complexexpression[OPTIONAL]Example: <lookup complexExpression="#foreach( $addr in $patient.addresses ) $!addr.cityVillage <br/> #end"/>Value: Valid complex velocity expressionDefault: None
class[OPTIONAL]Example: <lookup .../>Value: Valid velocity classDefault: None
expression[OPTIONAL]Example: <lookup expression="patient.personName"/>Value: Valid velocity expressionDefault: None[edit]

Wiki Spaces

Get Help from Others

Documentation

Page tree

HTML Form Entry Module HTML Reference

Tag Reference

<code>

<encounterDate>

Attributes

Example Usage <encounterDate/> <!- an initially-blank date widget ->

<encounterLocation>

Attributes

Example Usage <encounterLocation/> <!- a list of all locations, sorted alphabetically by name ->

<encounterProvider>

Attributes

Example Usage <encounterProvider/> <!- a list of all users ->

<enrollInProgram>

Attributes

<excludeIf>

Attributes

<htmlform>

Example Usage <htmlform>

<includeIf>

<lookup>

Attributes

Unknown macro: {patient.personName}

<macros>

Example Usage<htmlform>

<obs>

Data Types

Numeric

Boolean

Text

Date

Coded

Attributes

Related Tags

<obsgroup>

Attributes

Related Tags

Example Usage<obsgroup groupingConceptId="1234">

<render>

<repeat>

Related Tags

<template>

<render>

Example Usage<repeat>

<section>

Attributes

<submit>

Example<htmlform>

<template>

<translations>

Attributes

Related Tags

<code>

Attributes

<variant>

Attributes

Example Usage<translations defaultLocale="en">

<variant>

Other Examples & Tips

Linking to Pages