...
Remove all [bracketed] and/or red text before publishing! And also the purple note panels!
[Bracketed] text should be replaced with actual content.
Red text is instructional.
Header Case
Title of page and response option headers should be sentence case (to match how they display in the online system).
Other headers in page that aren’t response options should be title case (Description, On-Screen Instructions, etc.).
| Page Properties | |||||||
|---|---|---|---|---|---|---|---|
| |||||||
|
...
|
...
Use form_field and any relevant segment labels (asc, hospital, nursingfacility, pharmacy)
Use the relevant section label (e.g., surgical_event, event_information)
Note: event-specific fields should be tagged with the associated event type (e.g., surgical_event, fall_event) and NOT with overarching header “event_information”)
Use required if the field is required to submit for all reports.
For example, “it is required if it appears” should not be labeled “required.”
Use essential if the field is a top priority for transferring the data dictionary.
Note: if the field is required, it will already be considered “essential” and doesn’t need a second label.
All “essential” labels will need to be removed before the data dictionary goes live.
Description
[Brief description of what this field is collecting]
On-Screen Instructions
[Prompt text as it appears in the user interface.]
Prompt Text
If none or if field does not appear on-screen, put “n/a.” Use “include page” macro where possible (see examples below).
...
Field Type
[Type of field, but really type of interaction user will have: clicking a checkbox or radio button, choosing from a dropdown, filling in a date number, or text field, etc.]
Field Type
Use standard language below and delete the others. Use include page macro where possible (see examples, below).
Checkbox (multiselect)
Date (mm/dd/yyyy)
Number (minimum value: x; maximum value: x) [Delete min &/or max values if irrelevant]
Text (maximum length: x) [Delete maximum length if irrelevant]
Time (hh:mm)
...
OPTION ONE: Answer options with content (definition and/or inclusions, exclusions)
Add an anchor in front of the H1 “Responses” heading and name the anchor “Top.”
Include a table of contents, which should be limited to the answer option headers and displayed as a list.
Add a dividing line macro below the table of contents.
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
Answer Option Anchors and Headings
...
Definition
Copy/paste the “description” text from the data dictionary.
Includes
Excludes
Inclusions and Exclusions
Add a page layout of two equal columns below the definition. Inclusions go in the left column, exclusions in the right.
...
Event-Type Specific Questions
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...
Additional Support
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Event-Type Specific Questions
If the answer option triggers additional question, add a content by label macro to display all pages that share the form_field label plus the relevant answer option label, possibly plus the relevant segment label, depending on the situation. The macro goes in a single cell table with a light gray fill. The title above the macro should just be table text, bold (no header level), that reads: Event-Type Specific Questions.
Additional Support
If the answer option is associated with an “faq” item, add a second row to the table and paste in a content by label macro to display all pages that share the faq label plus the relevant answer option label, possibly plus the relevant segment label, depending on the situation. Macro should have title “Additional Support” in the table cell, above it, as with the “Event specific questions” macro.
Return to Top Links
...
Dividing Line
Add a dividing line after the “return to top” link and before the next answer option, or the next section (probably “Guide for Use”).
OPTION TWO: Answer options without content
Just list the available answer options without the answerID and answerCode.
[Answer option 1]
[Answer option 2]
[Answer option 3]
Guide for Use
...
Description
Determination of which facility is reporting.
On-Screen Instructions
Please select
Field Type
| Include Page | ||||
|---|---|---|---|---|
|
Responses
List of participants
Guide for Use
| Include Page | ||||
|---|---|---|---|---|
|
...
If the page should include “additional support” content that is is only relevant to this one question, move the content into the guide for use. If there are multiple pages for the question because of differences between segments, leave the content in a separate page and use the “include page” macro to include it (so we only have to edit in one place but it will still appear in multiple places).
...
Additional Support
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
History
Start Date | Spring 2012 |
|---|---|
End Date | n/a |
Change History | n/a |
...