Versions Compared

Version Old Version 2 New Version 3
Changes made by

Sydney Edlund

Sydney Edlund

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
hiddentrue

Initial Build

Status
titlenot started

Staff Review

Approval Status

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.” Use “include page” macro where possible (see examples below).

Include PageSelect only one excerpt

Select only one excerpt

Description

Adverse outcome sustained by the neonate.

On-Screen Instructions

Include Page
Check all that apply excerpt
Check all that apply excerpt

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
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)

Include Page
Checkbox excerpt
Checkbox excerpt
Include Page
Dropdown excerptDropdown excerpt
Include Page
Radio button excerptRadio button excerpt

Anchor
Top
Top
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.

Table of Contents
minLevel1
maxLevel7
excludeDescription|On-Screen Instructions|Field Type|Responses|Response Codes|OPSC Staff Notes|History|Guide for Use|Additional Support

Anchor
option1
option1
Answer option 1

Answer Option Anchors and Headings

Each answer option gets an anchor and an H2 heading in sentence case.

[Definition goes here.]

Includes

Excludes

Return to top

Answer option 1

[Definition goes here.]

Includes

Excludes

Return to top

Answer option 1

[Definition goes here.]

Includes

Excludes

Return to top

Answer option 1

Definition

Copy/paste the “description” text from the data dictionary.

[Definition goes here.]

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

Answer option 1

[Definition goes here.]

Includes

Excludes

Return to top

Answer option 1

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 responsestable 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]

    [Definition goes here.]

    Includes

    Include Page
    No additional guidance excerpt
    No additional guidance excerpt

    Excludes

    Return to top

    Other (please describe)

    Includes

    • Injuries to scalp

    • Fracture of clavicle

    • Other injuries to skeleton (e.g. fracture of long bones or skull)

    • Injury to spine and spinal cord

      • Dislocation of spine or spinal cord due to birth trauma

      • Fracture of spine or spinal cord due to birth trauma

      • Laceration of spine or spinal cord due to birth trauma

      • Rupture of spine or spinal cord due to birth trauma

    • Facial nerve injury

      • Facial palsy

    • Cranial and peripheral nerve injuries

      • Phrenic nerve paralysis

    • Eye damage

    • Hematoma of the liver (subcapsular), testes or vulva

    • Rupture of the liver or spleen

    • Scalpel wound

    • Traumatic glaucoma

    • Unspecified birth injury or trauma

    Excludes

    • Congenital dislocation of hip

    • Fracture of spine, congenital

    Return to top

    Guide for Use

    Include Page
    Other selection text excerpt
    Other selection text excerpt

    History

    Start Date

    Spring 2012

    End Date

    n/a

    Change History

    n/a

    [Month yyyy: brief description of change][Spring 2012: PSRP implementation]