Difference between revisions of "How to Write a Profile"

From QIBA Wiki
Jump to navigation Jump to search
Line 18: Line 18:
 
:* Profiles are about performance claims, not general best practices
 
:* Profiles are about performance claims, not general best practices
 
:* "Make the irreducible basic elements as simple and as few as possible" but not simpler/fewer. (Einstein)
 
:* "Make the irreducible basic elements as simple and as few as possible" but not simpler/fewer. (Einstein)
* If you would not fail someone for not conforming to the requirement, then don't make it a requirement.
+
* If you would not fail someone for not conforming to the requirement, then drop the requirement.
 
* Dropping requirements is fine but make sure you revise your claimed performance accordingly.
 
* Dropping requirements is fine but make sure you revise your claimed performance accordingly.
 +
* Put requirements in the Specification tables
 +
:* The Discussion section is for additional information but can be skipped by folks who just want the requirements; hiding additional requirements there would be sneaky.
 
* Start table requirements with the word "Shall"
 
* Start table requirements with the word "Shall"
 
:* This avoids passive voice.  Passive voice makes it unclear who is responsible for the requirement.
 
:* This avoids passive voice.  Passive voice makes it unclear who is responsible for the requirement.
 
* Don't use "shall" outside of tables or procedures.  
 
* Don't use "shall" outside of tables or procedures.  
 
:* Shall is for requirements.  If it's a requirement, put it in a table. If it's not a requirement, don't use shall.
 
:* Shall is for requirements.  If it's a requirement, put it in a table. If it's not a requirement, don't use shall.
 +
* List a single actor for each requirement
 +
:* It needs to be clear who is responsible for the requirement being met. You don't the requirement unmet because two people both thought the other was taking care of it
 +
:* The Profile doesn't care HOW the actor gets it done, and if they explicitly delegate it or hire someone that's fine, but if it's not done the Actor is responsible.
 +
:* The Profile doesn't care if one human takes on multiple roles.  In a given hospital the same person may take the role of both Radiologist and Image Analyst.
 +
:* Some profiles add notes in the discussion to clarify these details.
 
* For each requirement, consider how you would assess conformance
 
* For each requirement, consider how you would assess conformance
 
:* If assessing conformance is obvious and will be done consistently, that's fine.
 
:* If assessing conformance is obvious and will be done consistently, that's fine.
 
:* If it requires a specific procedure, add the procedure to section 4 and reference it.
 
:* If it requires a specific procedure, add the procedure to section 4 and reference it.
 
:* If it's practically unassessable, then it's not a useful requirement so drop it
 
:* If it's practically unassessable, then it's not a useful requirement so drop it

Revision as of 19:34, 5 January 2017

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

The template 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.

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.


<to be continued>

Rules of Thumb for Profile text

  • If it doesn't contribute to achieving the Claim, don't make it a requirement
  • Profiles are about performance claims, not general best practices
  • "Make the irreducible basic elements as simple and as few as possible" but not simpler/fewer. (Einstein)
  • If you would not fail someone for not conforming to the requirement, then drop the requirement.
  • Dropping requirements is fine but make sure you revise your claimed performance accordingly.
  • Put requirements in the Specification tables
  • The Discussion section is for additional information but can be skipped by folks who just want the requirements; hiding additional requirements there would be sneaky.
  • Start table requirements with the word "Shall"
  • This avoids passive voice. Passive voice makes it unclear who is responsible for the requirement.
  • Don't use "shall" outside of tables or procedures.
  • Shall is for requirements. If it's a requirement, put it in a table. If it's not a requirement, don't use shall.
  • List a single actor for each requirement
  • It needs to be clear who is responsible for the requirement being met. You don't the requirement unmet because two people both thought the other was taking care of it
  • The Profile doesn't care HOW the actor gets it done, and if they explicitly delegate it or hire someone that's fine, but if it's not done the Actor is responsible.
  • The Profile doesn't care if one human takes on multiple roles. In a given hospital the same person may take the role of both Radiologist and Image Analyst.
  • Some profiles add notes in the discussion to clarify these details.
  • For each requirement, consider how you would assess conformance
  • If assessing conformance is obvious and will be done consistently, that's fine.
  • If it requires a specific procedure, add the procedure to section 4 and reference it.
  • If it's practically unassessable, then it's not a useful requirement so drop it