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.).
Labels
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.” If automatically assigned, use excerpt text.
Field Type
Checkbox (multiselect)Responses
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.
Answer option 1
Answer Option Anchors and Headings
Each answer option gets an anchor and an H2 heading in sentence case.
[Definition goes here.]
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.
Return to Top Links
Below the page layout or Content by Label macro(s) (if relevant), include a link to the “top” anchor to take the user back to the responses table of content.
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
If “Other” is selected, a text box for a description will also appear.History
Start Date | Spring 2012 |
---|---|
End Date | n/a |
Change History | n/a [Month yyyy: brief description of change] [Spring 2012: PSRP implementation] |