Difference between revisions of "Template:FHIR IG Proposal"
Line 132: | Line 132: | ||
==Long Description== | ==Long Description== | ||
<noinclude><small><i> | <noinclude><small><i> | ||
− | <span style="color:#0000FF">1 paragraph describing the purpose/scope of the IG in more detail for inclusion in the | + | <span style="color:#0000FF">1 paragraph describing the purpose/scope of the IG in more detail for inclusion in the version history</span> |
</i></small><br/></noinclude> | </i></small><br/></noinclude> | ||
− | <!-- 1 paragraph describing the purpose/scope of the IG in more detail for inclusion in the | + | <!-- 1 paragraph describing the purpose/scope of the IG in more detail for inclusion in the version history --> |
==Involved parties== | ==Involved parties== | ||
<noinclude><small><i> | <noinclude><small><i> | ||
− | <span style="color:#0000FF">1 paragraph describing who is sponsoring or involved in creating the IG</span> | + | <span style="color:#0000FF">1 paragraph describing who is sponsoring or involved in creating the IG for inclusion in the version history</span> |
</i></small><br/></noinclude> | </i></small><br/></noinclude> | ||
− | <!-- 1 paragraph describing who is sponsoring or involved in creating the IG --> | + | <!-- 1 paragraph describing who is sponsoring or involved in creating the IG for inclusion in the version history --> |
Revision as of 19:28, 21 December 2017
To use this Template:
- Search (or Go to) for a page with name like xxxxx_FHIR_IG_Proposal
- Click on the RED link to the (previously) undefined page in order to edit it.
- Type {{subst::Template:FHIR IG Proposal}} as the only content for the new page.
- Preview (if desired) to verify the reference was typed correctly
- "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.
- At this point, the contents of this template (with the following exceptions) will replace the substitution link. The exceptions are:
- Re-edit the page to include the appropriate content in each of the sections
- Save again
For additional guidance on considerations for IG creation, refer to FHIR IG Considerations
Contents
- 1 PutProposedIGNameHere
- 1.1 Owning work group name
- 1.2 Committee Approval Date:
- 1.3 Contributing or Reviewing Work Groups
- 1.4 FHIR Development Project Insight ID
- 1.5 Scope of coverage
- 1.6 IG Purpose
- 1.7 Content location
- 1.8 Proposed IG realm and code
- 1.9 Short Description
- 1.10 Long Description
- 1.11 Involved parties
- 1.12 Expected implementations
- 1.13 Content sources
- 1.14 Example Scenarios
- 1.15 IG Relationships
- 1.16 Timelines
- 1.17 When IG Proposal Is Complete
- 1.18 FMG Notes
PutProposedIGNameHere
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?
Content location
What is the path within the HL7 github repository (i.e. https://github.com/HL7/xxx) 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 http://hl7.org/fhir? E.g. us/ccda
Short Description
1-2 sentences describing the purpose/scope of the IG for inclusion in the registry
Long Description
1 paragraph describing the purpose/scope of the IG in more detail for inclusion in the version history
Involved parties
1 paragraph describing who is sponsoring or involved in creating the IG for inclusion in the version history
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