Template:FHIR IG Proposal

From HL7Wiki
Revision as of 00:17, 9 November 2017 by Lmckenzi (talk | contribs) (Created page with "<noinclude> <!-- NOTE: If you edit the guidance text in this template, be sure to change both the content inside the 'noinclude' tags as well as the content inside the XML com...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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


PutProposedResourceNameHere

IG 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

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

Committee Approval Date:

Please enter the date that the committee approved this IGproposal

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. 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%"

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


IG Purpose

Why is this IG necessary?

Expected implementations

Key resources are justified by CCDA, for resources not deemed "key", what interest is there by implementers in using this particular resource. 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?

Timelines

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 FMGcontact@HL7.org

FMG Notes