Required Fields

  • Name
  • Identifier - A unique identifier for the template. Must be less than 255 characters. See Template/Profile Identifier Formats for more details.
  • Bookmark - A hyperlink anchor used in the MS Word document formatted export to allow cross-referencing. The bookmark must be unique, and must not contain any special characters (including spaces, with the exception of underscores). The bookmark may not be greater than 40 characters.
  • Implementation Guide - Choose from a drop-down list of implementation guides to assign the template/profile to a guide. The template/profile may also be referenced by other implementation guides (via contained or implied relationships).
  • Type - Choose from a list of available types (document, section, entry). Templates/profiles are organized by template type when an implementation guide is exported as an MS Word document. When you select a template type, the Applies To field is set. to a pre-determined default appropriate to that type.
  • Applies To - Choose the location in the base standard/schema where this template/profile can be used. The default is based on the selected template type, but can be customized by selecting the ellipsis (”...”) button to the right.
  • Extensibility - Choose whether instances of the template/profile can have additional information (open), or must contain only what is defined in the template/profile (closed).

Optional Fields

  • Implied Template - Choose a template/profile that supplies constraints implied in this template. Only those templates with the same Applies To values are available to select.
  • Extensibility - Choose whether the template/profile is Open or Closed.
  • Status - Choose the status of the template. Draft, Published, or Deprecated. Available options depend on the status of the implementation guide the template/profile is associated with.
  • Description - Enter a narrative description of the template. The text appears in an exported implementation guide. This field supports wiki formatting syntax.
  • Notes - Notes are available for review only by template/profile Analysts and Editors, and are not included in exports.

Template Identifier Formats

Template identifiers can be in one of the following formats:

  • urn:oid:XXXX
    Where XXXX is a valid OID (ex: 2.16.1.2.3.4)
  • urn:hl7ii:XXXX:YYYY-MM-DD
    Where XXXX is a valid OID
  • http(s)://XXXX
    Where XXXX is a web address representing the template