Implementation Guides
Fields for an Implementation Guide
- Name: Required. A name for the implementation guide.
- Display Name: The display name is used in publishable artifacts. If no display name is specified, the "name" is used instead.
- Type: Required. The type of templates/profile that will be stored in the implementation guide (ex: "CDA", "E-Measure" or "FHIR"). The type selected here directly corresponds to the XML schema that is used to build templates/profiles in the template/profile editor.
- Organization: Optional. The organization for which the implementation guide is being created
- Identifier/Base URL: Required.
- Consolidated Format: Exports MS Word documents using the consolidated formatting guidelines. This option is made available to support legacy implementation guides that were published prior to the guidelines defined by the consolidation project.
- Access Manager: A user with "edit" permissions that is responsible for receiving access requests and granting access to the IG.
- Allow Access Requests: Select "Yes" to make the implementation guide available in the "request access" window (when an access manager is defined). For more information, see Access Requests in the Permissions section.
Creating a New Implementation Guide
- From the Browse menu, choose Implementation Guides. The Implementation Guides page appears, showing a list of available implementation guides.
- At the right of the column header bar, select Add. The Add Implementation Guide page appears, as shown below.
- In the Name box, enter a name for your implementation guide.
- From the Type drop-down menu, choose an implementation guide type.
- Select the Organization the IG is being created for.
- Enter the Identifier/Base URL for the implementation guide that is a URL (ex: https://trifolia.lantanagroup.com/my_base_id").
- In the Display Name box enter the name that displays in forms and reports.
- Enter the Web Display Name for a the name that displays in the Web Viewer.
- In the Use Consolidated Constraint Format box, choose Yes or No.
- Optionally specify the Access Manager" of the implementation guide (IG), and if you want the IG to be available for access requests. See Access Requests for more details.
- Optionally specify whether or not to Allow access requests for this implementation guides.
- Select Save. The Implementation Guides page appears, and includes the new guide.
Adding Templates / Profiles to an Implementation Guide
- From the Browse menu, choose Templates/Profiles. A list of templates/profiles appears.
- Select the template/profile you want to add to the implementation guide. Use Trifolia's Automatic Lookup features to find the template/profile you want to add.
- In the Template/Profile browser , select the Edit icon. The Edit Template/Profile page appears with four tabs – Template/profile (active), Constraints, Preview, Validation.
- Select an implementation guide from the Implementation Guide drop-down, or type in the Implementation Guide box to use Trifolia's Automatic Lookup feature to locate the implementation guide to which you want to add the template/profile.
- At the bottom of the page, select Save. The template/profile is added to the implementation guide.
See Authoring > Templates/Profiles for more information
When you set the status of an implementation guide to Published, the templates associated with the guide are locked so they cannot be edited.
Publish an Implementation Guide
- From the Browse menu, choose Implementation Guides. The Implementation Guides page appears, showing a list of available implementation guides.
- Locate the implementation guide you want to publish.
- Select View to the right of the selected guide. The View Implementation Guide page appears, showing the details of the selected guide.
- From the Quick Buttons Workflow menu, choose Publish. A Select Publish Date box appears.
- Enter a date in the Publish Date box, or select a date in the pop-up calendar and select OK.
- The Publish Date is set to the specified date, the Publish Status is set to Published, and all associated templates/profiles, value sets, and code systems for the implementation guide are locked. The guide is published.
Delete an Implementation Guide
- From the Browse menu, choose Implementation Guides. The Implementation Guides page appears, showing a list of available implementation guides.
- Locate the implementation guide you want to delete.
- From the Actions menu for the selected guide, choose View. The Implementation Guide viewer appears, showing the templates used in the selected guide.
- Select Delete in the Quick Buttons selection. The Delete Implementation Guide page appears.
- Choose a Replacement Implementation Guide from the drop-down menu. Templates in the deleted guide are assigned to this guide after you delete.
Note: If you do not select a replacement guide, no guide is assigned to the templates/profiles in the selected guide. You will need to assign them manually to a template/profile. - Select Delete! A confirmation message box appears indicating “Are you absolutely sure you want to delete this implementation guide?”.
- Click OK on the confirmation message if you wish to delete the IG, and the implementation guide will be deleted, and the templates/profiles will be assigned to the specified replacement guide.