This wiki has undergone a migration to Confluence found Here

Difference between revisions of "Template:FHIR IG Proposal"

From HL7Wiki
Jump to navigation Jump to search
Line 38: Line 38:
Payer Coverage Decision Exchange
<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>
<!-- 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 work group name==

Revision as of 12:00, 2 July 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

Payer Coverage Decision Exchange

Owning work group name

The name of the work group that is proposed to have responsibility for developing and maintaining the IG.

Committee Approval Date:

Please enter the date that the committee approved this IGproposal

Publishing Lead

Name and email of the primary contact for the FMG with respect to publishing for this IG?</small

Contributing or Reviewing Work Groups

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

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 [[1]]

Scope of coverage

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.

Scope should consider numerous aspects of breadth of scope, including:

  • Subject: Human vs. non-human vs. non-patient (e.g. lab bench medicine)
  • 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

What is the path within the HL7 github repository (i.e. or what is the Simplifier project name?

Proposed IG realm and code

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 E.g. us/ccda

Maintenance Plan

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

1-2 sentences describing the purpose/scope of the IG for inclusion in the registry- this is the sentence that will be used here: 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

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: 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.

Involved parties

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.

Expected implementations

Provide named implementations if possible - ideally provide multiple independent implementations

Content sources

List all of the specifications (beyond those in the standard 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

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

Are there any IGs this resource depends on or that depend on this IG?


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

FMG Notes