Template:FHIR Profile Proposal

From HL7Wiki
Revision as of 21:31, 5 September 2017 by Annewiz (talk | contribs)
(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_Profile_Proposal
  2. Click on the RED link to the (previously) undefined page in order to edit it.
  3. Type {{subst::Template:FHIR Profile 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 profile proposal

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


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
  • Incorporate the name of the Resource being profiled

Profile balloting plans

Is profile expected to be published as part of the FHIR specification or as part of a separate implementation guide? (See FHIR_Profile_and_IG_Balloting)

Profile Details

Profiled Resource(s)

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.


Please describe the realm to which this profile applies, or indicate that it is realm neutral.


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



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

FMG Notes