Difference between revisions of "How to Write a Profile"

From QIBA Wiki
Jump to navigation Jump to search
(44 intermediate revisions by the same user not shown)
Line 1: Line 1:
Congratulations, you are an author, editor or contributor to a new QIBA Profile.  This is much like being a parent (including the "terrible 2's" and those rambunctious teenage years), challenging but rewarding.  Also, it does indeed "take a village" to raise a new Profile.  A diverse body of expertise  
+
{{TOCright}}
 +
Congratulations, you are an author, editor or contributor to a new QIBA Profile.  This is much like being a parent (including the "terrible 2's" and those rambunctious teenage years), challenging but rewarding.  Also, it does indeed "take a village" to raise a new Profile.  A diverse body of expertise is needed to nail down the intended clinical use cases for the biomarker, decide on an appropriate technical performance target, determine the key sources of variability that affect the performance, and draft clear requirements that eliminate, compensate or characterize each of those sources of variability.  You will need radiologists, physicists, bio-statisticians and engineers at the least.
  
:* '''Review the [[QIBA Profile Template]]'''
+
====Review the basic [[QIBA Concepts]]====
  
This should provide a sense of the content you will be developing.  Don't skip the Executive Summary, which highlights the structure, and pay attention to the Guidance comment boxes, which describe some of the issues and considerations you should start thinking about.
+
These are terms and ideas that will be referred to throughout the rest of this.
  
:* '''Review the Claim Guidance'''
+
====Review the [[QIBA Profile Template]]====
 +
 
 +
The template provides a sense of the content you will be developing.  Don't skip the Executive Summary, which highlights the structure, and '''read the Guidance comment boxes''', which describe issues and considerations you should start thinking about. (Really. Don't skip the Guidance comment boxes)
 +
 
 +
====Review the [[Claim Guidance]]====
  
 
The Biomarker Performance Claim is the anchor of the Profile.  The remainder of the profile is the Requirements necessary to achieve the claim, and the Assessment Procedures necessary to test the requirements.
 
The Biomarker Performance Claim is the anchor of the Profile.  The remainder of the profile is the Requirements necessary to achieve the claim, and the Assessment Procedures necessary to test the requirements.
  
As you will see in the Claim Guidance, coming up with good Claim(s) is not trivial.  Expect it to be an iterative process as your experience doing the groundwork and drafting the profile gives you a better appreciation.
+
As you will see in the Claim Guidance, coming up with good Claim(s) is not trivial.  Expect it to be an iterative process as your experience doing the groundwork and drafting the profile gives you a better appreciation.  New literature and evolving technology will also contribute to making it a bit of a moving target.
 +
 
 +
====Consider your [[Ground Truth Strategy]]====
 +
 
 +
The concepts of biomarker performance (for example in terms of bias or repeatability) and sources of variance presume some understanding of the "true value" of measurements.
 +
 
 +
====Plan and Conduct Groundwork Projects====
 +
 
 +
This is where you figure out what the critical sources of variance are for your biomarker and what requirements you need to write to actually achieve the Claim.
 +
 
 +
Hey, how hard can that be?  Seriously though, consult a biostatistician.  It's hard to give general guidance for this. 
 +
 
 +
During the groundwork and drafting process, keep in mind the three primary functions of a profile:
 +
* tell sites what can be accomplished by following the Profile. ("Profile Claims")
 +
* tell vendors what their product must do to state conformance with the Profile. ("Profile Details")
 +
* tell user staff what they must do to state conformance so the Profile Claims will be realized. ("Profile Details")
 +
 
 +
====Follow the [[Profile Writing Guidelines]]====
 +
 
 +
One of the hardest parts in drafting a Profile is figuring out what goes in, where to put it, what to cut, and how to word things. 
 +
 
 +
The [[Profile Writing Guidelines]] are intended to result in conformance text with clear requirements.
  
 +
====Further Reading====
  
:''<to be continued>''
+
Consult the '''[[Process|QIBA Process pages]]'''.  And let us know what information is missing so we can add it to our [[Process_Coordinating_Committee#Current_Work|ToDo list]].

Revision as of 22:02, 26 April 2021

Congratulations, you are an author, editor or contributor to a new QIBA Profile. This is much like being a parent (including the "terrible 2's" and those rambunctious teenage years), challenging but rewarding. Also, it does indeed "take a village" to raise a new Profile. A diverse body of expertise is needed to nail down the intended clinical use cases for the biomarker, decide on an appropriate technical performance target, determine the key sources of variability that affect the performance, and draft clear requirements that eliminate, compensate or characterize each of those sources of variability. You will need radiologists, physicists, bio-statisticians and engineers at the least.

Review the basic QIBA Concepts

These are terms and ideas that will be referred to throughout the rest of this.

Review the QIBA Profile Template

The template provides a sense of the content you will be developing. Don't skip the Executive Summary, which highlights the structure, and read the Guidance comment boxes, which describe issues and considerations you should start thinking about. (Really. Don't skip the Guidance comment boxes)

Review the Claim Guidance

The Biomarker Performance Claim is the anchor of the Profile. The remainder of the profile is the Requirements necessary to achieve the claim, and the Assessment Procedures necessary to test the requirements.

As you will see in the Claim Guidance, coming up with good Claim(s) is not trivial. Expect it to be an iterative process as your experience doing the groundwork and drafting the profile gives you a better appreciation. New literature and evolving technology will also contribute to making it a bit of a moving target.

Consider your Ground Truth Strategy

The concepts of biomarker performance (for example in terms of bias or repeatability) and sources of variance presume some understanding of the "true value" of measurements.

Plan and Conduct Groundwork Projects

This is where you figure out what the critical sources of variance are for your biomarker and what requirements you need to write to actually achieve the Claim.

Hey, how hard can that be? Seriously though, consult a biostatistician. It's hard to give general guidance for this.

During the groundwork and drafting process, keep in mind the three primary functions of a profile:

  • tell sites what can be accomplished by following the Profile. ("Profile Claims")
  • tell vendors what their product must do to state conformance with the Profile. ("Profile Details")
  • tell user staff what they must do to state conformance so the Profile Claims will be realized. ("Profile Details")

Follow the Profile Writing Guidelines

One of the hardest parts in drafting a Profile is figuring out what goes in, where to put it, what to cut, and how to word things.

The Profile Writing Guidelines are intended to result in conformance text with clear requirements.

Further Reading

Consult the QIBA Process pages. And let us know what information is missing so we can add it to our ToDo list.