Published 07-Feb-2025

PROMs style-guide University Hospital Basel

PRO part

Description

Example

Concept (PRO) name

Model as the full name of the PRO.

If the name is also used as an acronym, model the name in capitals, including the acronym in brackets.

If the most known name is an acronym, use the acronym as the name.

Patient Health Questionnaire-9 (PHQ-9)

Archetype ID

Same as concept name unless it is necessary to distinguish from another archetype with a similar name.

OBSERVATION.phq_9

Concept description

Record an explanation of the concept being recorded (not the PRO itself).

see Scores and Scales Style Guide

Purpose

Record the reason for using this archetype to record data, not to describe the purpose of the score or scale itself.

Commence the first sentence with the standard phrase "To record..." unless there is a good reason not to do so.

see Scores and Scales Style Guide

Use

(Record how the archetype might be used in implementation, not how to perform the assessment.

Commence the first sentence with the standard phrase "Use to
record..." unless there is a good reason not to do so.

Additional information might provide guidance to modellers or implementers about how to utilise the archetype in templates or clinical systems.

see Scores and Scales Style Guide

PRO-Question

RM Type

Use DV_Scale by default where applicable.

 

Label

Use short text representing the content of the question and include the question number if present in the PROM (as well as for superordinate clusters and answers to the question)

Short label: “1. Carrying groceries” (*see Full Question below)

Short label: “2. Vision impairment” (*see Full Question below)

Description

Record the full text question including the number of the question and the exact wording.

Full text question: “1. I have trouble carrying groceries in my daily life.”

Full text question: “2. I have a hard time reading traffic signs while driving.”

Comment

Add further info for explicit styling requirements necessary for PROM Validation.

Add further information about conditional rendering.

Have “in the last 2 weeks” in bold font.

If response “I felt dizzy” was selected ask questions 5, 6 and 7.

(This might lead to broader acceptance since the datamodel is “helping” the implementor to create a faithful representation of the PROM)

Superordinate PRO-Instruction

Use Cluster if there is one parent-container for a group of
questions. Label and description follow the same rules like for PRO question.
A container/question combination could look like this:
Superordinate Instruction/Question 1.
Subordinate Questions 1a, 1b, …

Cluster Label: “1. List of weekly activities”

Cluster Description: “1. The Following is a list of activities that people do during the week. […] Go over the activities and indicate your level of limitation over the past weeks:”

Subordinate PRO-Question

Use the same as per PRO-Question.
A container/question combination could look like this:
Superordinate Instruction/Question 1.
Subordinate Questions 1a, 1b, …

Label: “1 b. Over the past 4 weeks, how

Description: “1 b. Gardening, vacuuming or carrying groceries” etc…

Total Score

Naming of the total score or calculated ratio should not contain the name of the score or scale.

see Scores and Scales Style Guide

Related content