Difference between revisions of "Template:FHIR IG Proposal"

From HL7Wiki
Jump to navigation Jump to search
(Undo revision 166223 by Rdieterle (talk))
(Breast Radiology FHIR IG Proposal)
 
Line 38: Line 38:
  
  
=PutProposedIGNameHere=
+
=Breast Radiology Profiles=
<noinclude><small><i>
 
<span style="color:#0000FF">IG names should meet the following characteristics:</span>
 
* <span style="color:#0000FF">Title Case</span>
 
* <span style="color:#0000FF">U.S. English</span>
 
* <span style="color:#0000FF">Domain-friendly</span>
 
* <span style="color:#0000FF">Short</span>
 
* <span style="color:#0000FF">Clear</span>
 
* <span style="color:#0000FF">Unique</span>
 
* <span style="color:#0000FF">Avoid non-universal abbreviations (e.g. URL would be ok)</span>
 
* <span style="color:#0000FF">Be consistent with other similar IGs</span>
 
</i></small><br/></noinclude>
 
<!-- Resource names should meet the following characteristics:
 
* Title Case
 
* U.S. English
 
* Domain-friendly
 
* Short
 
* Clear
 
* Unique
 
* Avoid non-universal abbreviations (e.g. URL would be ok)
 
* Be consistent with other similar IGs
 
-->
 
  
==Owning work group name==
+
==Owning Workgroup==
<noinclude><small><span style="color:#0000FF"><i>
+
HL7 Clinical Interoperability Council (CIC)
The name of the work group that is proposed to have responsibility for developing and maintaining the IG.
 
</i></span></small><br/></noinclude>
 
<!-- The name of the committee that is proposed to have responsibility for developing and maintaining the IG. -->
 
[[YourWorkGroupName]]
 
  
 
==Committee Approval Date:==
 
==Committee Approval Date:==
<i>Please enter the date that the committee approved this IGproposal</i>
+
May 2019
  
 
==Publishing Lead==
 
==Publishing Lead==
<noinclude><small><span style="color:#0000FF"><i>Name and email of the primary contact for the FMG with respect to publishing for this IG?</i></span></small</br/></noinclude>
+
Richard Esmond (richard.esmond@gmail.com)
<!--Name and email of the primary contact for the FMG with respect to publishing for this IG?-->
 
  
 
==Contributing or Reviewing Work Groups==
 
==Contributing or Reviewing Work Groups==
<noinclude><small><span style="color:#0000FF"><i>
+
  HL7 Clinical Information Modeling Initiative (CIMI)
Additional work groups that may have an interest in contributing to, or reviewing the content of the IG (optional)
+
  HL7 Imaging Integration / DICOM
</i></span></small><br/></noinclude>
 
<!-- Additional work groups that may have an interest in contributing to, or reviewing  the content of the IG (optional) -->
 
* Work Group Name
 
* or link
 
* or "None"
 
  
 
==FHIR Development Project Insight ID==
 
==FHIR Development Project Insight ID==
<noinclude><small><span style="color:#0000FF"><i>
+
1363
Please specify the id of your work group’s PSS for doing FHIR work that covers the development and maintenance of this IG.  (If submitted but not yet approved, just write “pending”.)  The link to the PSS template can be found [[http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc|here]]
 
</i></span></small><br/></noinclude>
 
<!-- Please specify the id of your work group’s PSS for doing FHIR work that covers the development and maintenance of this IG.  (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found here: http://gforge.hl7.org/gf/download/docmanfileversion/6832/9398/HL7FHIR_DSTUballotPSS-20120529.doc -->
 
  
 
==Scope of coverage==
 
==Scope of coverage==
<noinclude><small><i>
+
The breast radiology implementation guide intends to formalize the radiology-specific data-elements sufficient to support breast cancer diagnosis, treatment and research, focusing on the key data necessary to facilitate clinical decision-making for medical and surgical oncologists, pathologists and the referring physician community of general practices Obstetrics and gynecology (OB/GYN) clinicians who order the vast majority of screening mammography procedures.
<span style="color:#0000FF">Define the full scope of coverage for the IG.  <b>(NOT the project - Do NOT copy from the PSS)</b>  The scope must be clearly delineated such that it does not overlap with any other existing or expected HL7 Int'l-maintained IG.  The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%".  Essentially, set the boundaries that would determine whether new content brought to HL7 should fall within the scope of your IG or somewhere else.  This should be 1 paragraph max.</span>
 
  
<span style="color:#0000FF">Scope should consider numerous aspects of breadth of scope, including:</span>
+
The implementation guide is expected to incrementally cover a wide variety breast radiology use cases, while supporting secondary data use in for clinical research, cancer registry reporting.</span>
* <span style="color:#0000FF">Subject: Human vs. non-human vs. non-patient (e.g. lab bench medicine)</span>
 
* <span style="color:#0000FF">Disciplines: Environmental Health, Palliative, Respiratory, Psychology, Maternity, Clinical Research</span>
 
* <span style="color:#0000FF">Delivery environment (Community, Geriatric, Home care, Emergency, Inpatient, Intensive, Neonatal, Pediatric, Primary)</span>
 
* <span style="color:#0000FF">Locale: Country, region</span>
 
  
</i></small><br/></noinclude>
+
==Content location==
<!-- Define the full scope of coverage for the IG.  **(NOT the project - Do NOT copy from the PSS)**  The scope must be clearly delineated such that it does not overlap with any other existing or expected HL7 Int'l-maintained IG.  The scope will be used to govern "what is the set of potential applications to consider when evaluating what elements are 'core' – i.e. in the 80%".  Essentially, set the boundaries that would determine whether new content brought to HL7 should fall within the scope of your IG or somewhere else.  This should be 1 paragraph max.
+
<i><span>https://github.com/HL7/fhir-breast-radiology-ig</span></i>
  
Scope should consider numerous aspects of breadth of scope, including:
+
==Proposed IG realm and code==
* Subject: Human vs. non-human vs. non-patient (e.g. lab bench medicine)
+
us/breast-radiology
* Disciplines: Environmental Health, Palliative, Respiratory, Psychology, Maternity, Clinical Research
 
* Delivery environment (Community, Geriatric, Home care, Emergency, Inpatient, Intensive, Neonatal, Pediatric, Primary)
 
* Locale: Country, region
 
-->
 
  
==Content location==
+
==Maintenance Plan==
<noinclude><small><i>
+
The CIC WG is aware and willing to maintain the content in the future. Among participants, at least MITRE, MRS and PenRad are committed to the maintenance of the content.
<span style="color:#0000FF">What is the path within the HL7 github repository (i.e. https://github.com/HL7/xxx) or what is the Simplifier project name?</span>
 
</i></small><br/></noinclude>
 
<!-- What is the path within the HL7 github repository (i.e. https://github.com/HL7/xxx) or what is the Simplifier project name? -->
 
  
 +
This IG comprises FHIR Profiles for breast radiology core data elements long established to be critical for breast cancer diagnosis and staging within the scope of radiology.
  
==Proposed IG realm and code==
+
In the first 'For Comment' cycle the terminology bindings are preliminary, and in some cases, defined in terms of local codes only.
<noinclude><small><i>
 
<span style="color:#0000FF">What is the realm code (2-character country code or 'uv') and IG code to use for the path when the IG is published under http://hl7.org/fhir?  E.g. us/ccda</span>
 
</i></small><br/></noinclude>
 
<!-- What is the realm code (2-character country code or 'uv') and IG code to use for the path when the IG is published under http://hl7.org/fhir?  E.g. us/ccda -->
 
  
==Maintenance Plan==
+
Our team is collaborating with the VA SOLOR groups, RSNA RadLex and Regenstrief (LOINC) to organize and fund the required unique concept authoring efforts that will be necessary to sufficiently define the data-elements and value-sets represented in the 'For Comment' and 'Informative' breast-radiology draft ballot cycles.
<noinclude><small><i>
 
<span style="color:#0000FF">What commitment does the WG have to maintaining this IG as the FHIR core specification continues to evolve - particularly if the initial project sponsors are no longer providing resources.  I.e. Who will be maintaining this IG content 5 years after it's published?</span>
 
</i></small><br/></noinclude>
 
<!-- What commitment does the WG have to maintaining this IG as the FHIR core specification continues to evolve - particularly if the initial project sponsors are no longer providing resources.  I.e. Who will be maintaining this IG content 5 years after it's published? -->
 
  
 
==Short Description==
 
==Short Description==
<noinclude><small><i>
+
Breast Radiology CIMI Logical Models and FHIR Profiles.
<span style="color:#0000FF">1-2 sentences describing the purpose/scope of the IG for inclusion in the registry- this is the sentence that will be used here: http://www.fhir.org/guides/registry.  This must describe the IG from the perspective of an implementer scanning a registry, it should not talk about the project and should NOT be copied from the PSS.</span>
 
</i></small><br/></noinclude>
 
<!-- 1-2 sentences describing the purpose/scope of the IG for inclusion in the registry- this is the sentence that will be used here: http://www.fhir.org/guides/registry.  This must describe the IG from the perspective of an implementer scanning a registry, it should not talk about the project and should NOT be copied from the PSS. -->
 
 
 
  
 
==Long Description==
 
==Long Description==
<noinclude><small><i>
+
The first iteration of the CIMI logical models and FHIR Profiles for breast radiology reporting will be focused on the core modeling structures, patterns and informational relationships between these architectural elements. Our group has works extensively with the HL7 Orders and Observations workgroup to investigate the numerous 'cross cutting' concerns that confront many similar projects.
<span style="color:#0000FF">1(-2) paragraphs describing the purpose/scope of the IG in more detail for inclusion in the version history - this is content that will be used in your IG's equivalent of this: http://www.hl7.org/fhir/us/core/history.cfml.  Again, this must describe the IG from the perspective of an implementer scanning a registry, it should not talk about the project and should NOT be copied from the PSS.</span>
 
</i></small><br/></noinclude>
 
<!-- 1-2 paragraphs describing the purpose/scope of the IG in more detail for inclusion in the version history - this is content that will be used in your IG's equivalent of this: http://www.hl7.org/fhir/us/core/history.cfml.  Again, this must describe the IG from the perspective of an implementer scanning a registry, it should not talk about the project and should NOT be copied from the PSS. -->
 
  
 +
This IG defines FHIR profiles for data elements that are either directly or indirectly used in the reporting of breast radiology.
  
 
==Involved parties==
 
==Involved parties==
<noinclude><small><i>
+
The breast-radiology IG is being authored through a formal collaboration under the HL7-CIC workgroup with a wide range of organizations and individual contributors that informally refer the themselves as the 'Cancer Interoperability' Group, which includes representatives from the FDA, NIH, CCO, SBI, HSPC, CiiC, ACS, various health IT vendors and interested solution vendors.
<span style="color:#0000FF">1 paragraph describing who is sponsoring or involved in creating the IG <b>for inclusion in the version history</b>.  Don't copy from the PSS - think about the specific language you want to appear in the registry.</span>
 
</i></small><br/></noinclude>
 
<!-- 1 paragraph describing who is sponsoring or involved in creating the IG **for inclusion in the version history**.  Don't copy from the PSS - think about the specific language you want to appear in the registry. -->
 
  
 +
The American College of Radiology (ACR) has will established and long standing guidelines that have been in common and broad use for almost two decades. The Radiological Society of North America (RSNA) and the Society of Breast Imaging (SBI) which the breast focused arm of the ACR are all represented on the subject matter expert team that is reviewing all content and will be used as the definitive source of truth for all our near-term deliverables.
  
 
==Expected implementations==
 
==Expected implementations==
<noinclude><small><span style="color:#0000FF"><i>
+
  MITRE's Standard Health Record Collaborative
Provide named implementations if possible - ideally provide multiple independent implementations
+
  PenRad, Inc.
</i></span></small><br/></noinclude>
+
  Mammography Reporting System, inc (MRS).
<!--Provide named implementations if possible - ideally provide multiple independent implementations. -->
+
 
 +
  PenRad and MRS represent well over fifty percent of the almost forty million screening mammography studies performed each year. PenRad and MRS are also committed to participating in FHIR Connectathons to proof the draft profiles.
  
 
==Content sources==
 
==Content sources==
<noinclude><small><span style="color:#0000FF"><i>
+
  American College of Radiology Breast Reporting Guidelines
<span style="color:#0000FF">List all of the specifications (beyond those in the [[FHIR_Design_Requirements_Sources|standard]] list of source specifications) that you’re planning to consult</span>
+
  College of American Pathology (CAP) Breast Reporting SDC Forms
 
+
  Society of Breast Imaging Reporting Guidelines
<span style="color:#0000FF">Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider?</span>
+
  In addition to sources specifically providing clinical content related to cancer and breast cancer, from a modeling perspective, CIMI models were also used as a source.</span>
</i></span></small><br/></noinclude>
 
<!-- List all of the specifications (beyond those in the "standard" (FHIR_Design_Requirements_Sources) list of source specifications) that you’re planning to consult
 
 
 
Are there any source specifications that you wish to consult but are concerned about access to or expertise to consider? -->
 
  
 
==Example Scenarios==
 
==Example Scenarios==
<noinclude><small><span style="color:#0000FF"><i>
+
  Capture and delivery of breast radiology reports to EHR systems
<span style="color:#0000FF">Provide a listing of the types of scenarios to be represented in the examples produced for this IG.  They should demonstrate the full scope of the IG and allow exercising of the IG's capabilities (all profiles, different types of applications, etc.)</span>
+
  Reporting to cancer registries
</i></span></small><br/></noinclude>
+
  Reporting for clinical trials
<!-- Provide a listing of the types of scenarios to be represented in the examples produced for this IG.  They should demonstrate the full scope of the IG and allow exercising of the IG's capabilities (all profiles, different types of applications, etc.) -->
 
  
 
==IG Relationships==
 
==IG Relationships==
<noinclude><small><i>
+
The breast-radiology project is intended to target compliance with US Core v4.
<span style="color:#0000FF">Are there any IGs this resource depends on or that depend on this IG?</span>
 
</i></small><br/></noinclude>
 
<!-- Are there any IGs this resource depends on or that depend on this IG? -->
 
  
 
==Timelines==
 
==Timelines==
<noinclude><small><span style="color:#0000FF"><i>
+
  For Comment September 2019 Ballot
Indicate the target date for having the IGcomplete from a committee perspective and ready for vetting and voting
+
  Informative Jan 2020 Ballot
</i></span></small><br/></noinclude>
+
  STU May 2020 Ballot
<!-- Indicate the target date for having the IGcomplete from a committee perspective and ready for vetting and voting -->
 
  
==When IG Proposal Is Complete==
 
'''When you have completed your proposal, please send an email to [mailto:FMGcontact@HL7.org FMGcontact@HL7.org]'''
 
  
 
==FMG Notes==
 
==FMG Notes==

Latest revision as of 16:50, 8 August 2019

To use this Template:

  1. Search (or Go to) for a page with name like xxxxx_FHIR_IG_Proposal
  2. Click on the RED link to the (previously) undefined page in order to edit it.
  3. Type {{subst::Template:FHIR IG Proposal}} as the only content for the new page.
  4. Preview (if desired) to verify the reference was typed correctly
  5. "Save" the page.
    At this point, the contents of this template (with the following exceptions) will replace the substitution link. The exceptions are:
    • These instructions will not appear.
    • The small blue-font annotations about each entry will be replaced with an <!-- XML Comment --> saying the same thing. These comments are visible while editing, but they do not appear when the Wiki page is previewed or saved.
  6. Re-edit the page to include the appropriate content in each of the sections
  7. Save again

IMPORTANT: DO NOT COPY & PASTE FROM YOUR PSS: The purpose of the elements in the IG Proposal is different. The IG Proposal should not talk about the "project" at all.

The displayed contents below this line is the outline for a resource proposal


For additional guidance on considerations for IG creation, refer to FHIR IG Considerations


Breast Radiology Profiles

Owning Workgroup

HL7 Clinical Interoperability Council (CIC)

Committee Approval Date:

May 2019

Publishing Lead

Richard Esmond (richard.esmond@gmail.com)

Contributing or Reviewing Work Groups

  HL7 Clinical Information Modeling Initiative (CIMI)
  HL7 Imaging Integration / DICOM

FHIR Development Project Insight ID

1363

Scope of coverage

The breast radiology implementation guide intends to formalize the radiology-specific data-elements sufficient to support breast cancer diagnosis, treatment and research, focusing on the key data necessary to facilitate clinical decision-making for medical and surgical oncologists, pathologists and the referring physician community of general practices Obstetrics and gynecology (OB/GYN) clinicians who order the vast majority of screening mammography procedures.

The implementation guide is expected to incrementally cover a wide variety breast radiology use cases, while supporting secondary data use in for clinical research, cancer registry reporting.

Content location

https://github.com/HL7/fhir-breast-radiology-ig

Proposed IG realm and code

us/breast-radiology

Maintenance Plan

The CIC WG is aware and willing to maintain the content in the future. Among participants, at least MITRE, MRS and PenRad are committed to the maintenance of the content.

This IG comprises FHIR Profiles for breast radiology core data elements long established to be critical for breast cancer diagnosis and staging within the scope of radiology.

In the first 'For Comment' cycle the terminology bindings are preliminary, and in some cases, defined in terms of local codes only.

Our team is collaborating with the VA SOLOR groups, RSNA RadLex and Regenstrief (LOINC) to organize and fund the required unique concept authoring efforts that will be necessary to sufficiently define the data-elements and value-sets represented in the 'For Comment' and 'Informative' breast-radiology draft ballot cycles.

Short Description

Breast Radiology CIMI Logical Models and FHIR Profiles.

Long Description

The first iteration of the CIMI logical models and FHIR Profiles for breast radiology reporting will be focused on the core modeling structures, patterns and informational relationships between these architectural elements. Our group has works extensively with the HL7 Orders and Observations workgroup to investigate the numerous 'cross cutting' concerns that confront many similar projects.

This IG defines FHIR profiles for data elements that are either directly or indirectly used in the reporting of breast radiology.

Involved parties

The breast-radiology IG is being authored through a formal collaboration under the HL7-CIC workgroup with a wide range of organizations and individual contributors that informally refer the themselves as the 'Cancer Interoperability' Group, which includes representatives from the FDA, NIH, CCO, SBI, HSPC, CiiC, ACS, various health IT vendors and interested solution vendors.

The American College of Radiology (ACR) has will established and long standing guidelines that have been in common and broad use for almost two decades. The Radiological Society of North America (RSNA) and the Society of Breast Imaging (SBI) which the breast focused arm of the ACR are all represented on the subject matter expert team that is reviewing all content and will be used as the definitive source of truth for all our near-term deliverables.

Expected implementations

  MITRE's Standard Health Record Collaborative
  PenRad, Inc. 
  Mammography Reporting System, inc (MRS). 
  PenRad and MRS represent well over fifty percent of the almost forty million screening mammography studies performed each year. PenRad and MRS are also committed to participating in FHIR Connectathons to proof the draft profiles.

Content sources

  American College of Radiology Breast Reporting Guidelines 
  College of American Pathology (CAP) Breast Reporting SDC Forms
  Society of Breast Imaging Reporting Guidelines
  In addition to sources specifically providing clinical content related to cancer and breast cancer, from a modeling perspective, CIMI models were also used as a source.

Example Scenarios

  Capture and delivery of breast radiology reports to EHR systems
  Reporting to cancer registries
  Reporting for clinical trials

IG Relationships

The breast-radiology project is intended to target compliance with US Core v4.

Timelines

  For Comment September 2019 Ballot
  Informative Jan 2020 Ballot
  STU May 2020 Ballot


FMG Notes