Difference between revisions of "Template:FHIR Profile Proposal"
Hugh Glover (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 commen...") |
Hugh Glover (talk | contribs) |
||
| Line 28: | Line 28: | ||
</div> | </div> | ||
[[Category:FHIR Resource Proposal]] | [[Category:FHIR Resource Proposal]] | ||
| − | [[Category:Pending FHIR | + | [[Category:FHIR Profile Proposal]] |
| + | [[Category:Pending FHIR Profile Proposal]] | ||
<noinclude> | <noinclude> | ||
| Line 73: | Line 74: | ||
--> | --> | ||
| − | ==Parent Resource== | + | ==Resource Details== |
| + | |||
| + | ===Parent Resource=== | ||
<noinclude> | <noinclude> | ||
<small> | <small> | ||
<span style="color:#0000FF"> | <span style="color:#0000FF"> | ||
<i> | <i> | ||
| − | Put a link to the resource that will be profiled here. | + | Put a link to the resource/datatype (or group of resources) that will be profiled here. |
</i> | </i> | ||
</span> | </span> | ||
| Line 84: | Line 87: | ||
<br/> | <br/> | ||
</noinclude> | </noinclude> | ||
| − | <!--Put a link to the resource that will be profiled here.--> | + | <!--Put a link to the resource/datatype (or group of resources) that will be profiled here.--> |
* [[ParentResourceAddress|ResourceName]] | * [[ParentResourceAddress|ResourceName]] | ||
| − | ===Constraints to be Applied=== | + | ====Constraints to be Applied==== |
<noinclude> | <noinclude> | ||
<small> | <small> | ||
| Line 102: | Line 105: | ||
* Constraint 2 | * Constraint 2 | ||
| − | ===Extensions to be Applied=== | + | ====Extensions to be Applied==== |
<noinclude> | <noinclude> | ||
<small> | <small> | ||
| Line 117: | Line 120: | ||
* Extension 2 | * Extension 2 | ||
| − | ==Example Scenarios== | + | ===Example Scenarios=== |
<noinclude> | <noinclude> | ||
<small> | <small> | ||
| Line 130: | Line 133: | ||
<!-- Provide a listing of the types of scenarios to be represented in the examples produced for this Profile. They should demonstrate the full scope of the Profile and allow exercising of the Profiles capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) --> | <!-- Provide a listing of the types of scenarios to be represented in the examples produced for this Profile. They should demonstrate the full scope of the Profile and allow exercising of the Profiles capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.) --> | ||
| − | ==Scope of coverage== | + | ===Scope of coverage=== |
<noinclude> | <noinclude> | ||
<small> | <small> | ||
| Line 158: | Line 161: | ||
--> | --> | ||
| − | ==Owning committee name== | + | ==Ownership== |
| + | ===Owning committee name=== | ||
<noinclude> | <noinclude> | ||
<small> | <small> | ||
| Line 172: | Line 176: | ||
[[YourCommitteeName]] | [[YourCommitteeName]] | ||
| − | ==Contributing or Reviewing Work Groups== | + | ===Contributing or Reviewing Work Groups=== |
<noinclude> | <noinclude> | ||
<small> | <small> | ||
| Line 188: | Line 192: | ||
* or "None" | * or "None" | ||
| − | == | + | ===Expected implementations=== |
| + | <noinclude> | ||
| + | <small> | ||
| + | <span style="color:#0000FF"> | ||
| + | <i> | ||
| + | Key Profiles are justified by CCDA, for Profiles not deemed "key", what interest is there by implementers in using this particular Profile. Provide named implementations if possible - ideally provide multiple independent implementations | ||
| + | </i> | ||
| + | </span> | ||
| + | </small> | ||
| + | <br/> | ||
| + | </noinclude> | ||
| + | <!--Key Profiles are justified by CCDA, for Profiles not deemed "key", what interest is there by implementers in using this particular Profile. Provide named implementations if possible - ideally provide multiple independent implementations. --> | ||
| + | |||
| + | ===gForge Users=== | ||
<noinclude> | <noinclude> | ||
<small> | <small> | ||
<span style="color:#0000FF"> | <span style="color:#0000FF"> | ||
<i> | <i> | ||
| − | + | Identify the userids who will require commit access to gForge to maintain the Profile. (Ensure all users have registered for gForge.) | |
</i> | </i> | ||
</span> | </span> | ||
| Line 199: | Line 216: | ||
<br/> | <br/> | ||
</noinclude> | </noinclude> | ||
| − | <!-- | + | <!-- Identify the userids who will require commit access to gForge to maintain the Profile. (Ensure all users have registered for gForge.) --> |
| + | |||
| − | == | + | ===FHIR Profile Development Project Insight ID=== |
<noinclude> | <noinclude> | ||
<small> | <small> | ||
<span style="color:#0000FF"> | <span style="color:#0000FF"> | ||
<i> | <i> | ||
| − | + | Please specify the id of your work group’s PSS for doing FHIR work. (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> | </i> | ||
</span> | </span> | ||
| Line 212: | Line 230: | ||
<br/> | <br/> | ||
</noinclude> | </noinclude> | ||
| − | <!-- | + | <!-- Please specify the id of your work group’s PSS for doing FHIR work. (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 --> |
| − | ==Timelines== | + | ==Plans== |
| + | ===Timelines=== | ||
<noinclude> | <noinclude> | ||
<small> | <small> | ||
| Line 226: | Line 245: | ||
</noinclude> | </noinclude> | ||
<!-- Indicate the target date for having the Profile complete from a committee perspective and ready for vetting and voting --> | <!-- Indicate the target date for having the Profile complete from a committee perspective and ready for vetting and voting --> | ||
| + | *TargetDateForInternalReview | ||
| − | == | + | ===Balloting Requirements=== |
<noinclude> | <noinclude> | ||
<small> | <small> | ||
<span style="color:#0000FF"> | <span style="color:#0000FF"> | ||
<i> | <i> | ||
| − | + | Indicate the intended method of balloting by choosing one of the options below, or propose alternative. If Realm Specific or No Ballot indicate the amount of informal review required by the FHIR community. | |
</i> | </i> | ||
</span> | </span> | ||
| Line 238: | Line 258: | ||
<br/> | <br/> | ||
</noinclude> | </noinclude> | ||
| − | <!-- | + | <!-- Indicate the intended method of balloting by choosing one of the options below, or propose alternative. If Realm Specific or No Ballot indicate the amount of informal review required by the FHIR community.--> |
| + | |||
| + | Choose one: | ||
| + | *Ballot with next FHIR DSTU or Normative Edition | ||
| + | *or Ballot independently as DSTU | ||
| + | *or Realm specific ballot | ||
| + | *or No Ballot | ||
| + | |||
| + | <!-- Indicate the desired ballot date.--> | ||
| + | Desired Ballot Date | ||
| + | *PutDesiredBallotDateHere | ||
Revision as of 14:34, 12 February 2014
To use this Template:
- Search (or Go to) for a page with name like xxxxx_FHIR_Profile_Proposal
- Click on the RED link to the (previously) undefined page in order to edit it.
- Type {{subst::Template:FHIR Profile 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
This page documents a Pending FHIR Resource Proposal
For additional guidance on considerations for profile creation, refer to FHIR Profile Considerations
PutProposedProfileNameHere
Profile names should meet the following characteristics:
- Upper camel case
- U.S. English
- Domain-friendly
- Short
- Clear
- Unique
- Avoid non-universal abbreviations (e.g. URL would be ok)
- Be expressed as a noun
- Be consistent with other similar Profiles
Resource Details
Parent Resource
Put a link to the resource/datatype (or group of resources) that will be profiled here.
Constraints to be Applied
Describe how the current resource will be constrained.
- Constraint 1
- Constraint 2
Extensions to be Applied
Describe how the current resource will be extended.
- Extension 1
- Extension 2
Example Scenarios
Provide a listing of the types of scenarios to be represented in the examples produced for this Profile. They should demonstrate the full scope of the Profile and allow exercising of the Profiles capabilities (full element coverage, inclusion & omission of optional elements, repeating and singleton repeating elements, etc.)
Scope of coverage
Define the full scope of coverage for the Profile. The scope must be clearly delineated such that it does not overlap with any other existing or expected Profile. 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
As a rule, Profiles should encompass all of these aspects.
Ownership
Owning committee name
The name of the committee that is proposed to have responsibility for developing and maintaining the Profiles.
Contributing or Reviewing Work Groups
Additional work groups that may have an interest in contributing to, or reviewing the content of the Profile (optional)
- Work Group Name
- or link
- or "None"
Expected implementations
Key Profiles are justified by CCDA, for Profiles not deemed "key", what interest is there by implementers in using this particular Profile. Provide named implementations if possible - ideally provide multiple independent implementations
gForge Users
Identify the userids who will require commit access to gForge to maintain the Profile. (Ensure all users have registered for gForge.)
FHIR Profile Development Project Insight ID
Please specify the id of your work group’s PSS for doing FHIR work. (If submitted but not yet approved, just write “pending”.) The link to the PSS template can be found [[1]]
Plans
Timelines
Indicate the target date for having the Profile complete from a committee perspective and ready for vetting and voting
- TargetDateForInternalReview
Balloting Requirements
Indicate the intended method of balloting by choosing one of the options below, or propose alternative. If Realm Specific or No Ballot indicate the amount of informal review required by the FHIR community.
Choose one:
- Ballot with next FHIR DSTU or Normative Edition
- or Ballot independently as DSTU
- or Realm specific ballot
- or No Ballot
Desired Ballot Date
- PutDesiredBallotDateHere
