How do I link to content in MAGICapp - guidelines, sections, recommendations, SoF/PICOs (Links and Widgets)

Modified on Wed, 17 Jul at 12:37 PM

Links to content in MAGICapp use specific IDs and shortCode IDs, to enable the links to work even if the content is updated, or the place of the content within a guideline is changed. Below is an explanation of the different parts of the link string, so you understand more how it is built and how it can be used.

You can create hyperlinks for:

Guidelines
Sections
Recommendations

Image: https://help.magicapp.org/assets/239191384/All%20link%20options.png

You can create widgets (to embed or use as pop-ups) for:

Recommendations (see Help article for details)
PICOs (see Help article for details)

In general about specific IDs and shortCode IDs

All guidelines, sections, recommendations, and recommendation/PICO widgets have a version-specific ID and an across-version shortCode ID (i.e. the "permalink").
The shortCode (permalink) stays the same throughout all versions, so we use that in the link when we want to send users/display the most recent version. This link is the most appropriate option for almost all uses.
The version specific ID can be used when you want to show a specific version of a guideline, recommendation, section, or PICO. There may be some use cases where it's necessary to take users to a specific version (e.g. when referencing to an earlier recommendation that has since been changed and/or adapted).

Note: If you use the specific ID in a guideline link, or a recommendation link, and there is a more recent version available, the user will get a message: "There is a newer version of the guideline available, do you want to be taken to it instead?" If user clicks yes, they will be taken to the most recent version. For the PICO widgets, we don’t yet have this forwarding mechanism, so if you use the specific ID, that is what the user will see, no matter if there is a newer version.

Guidelines

You can find both the permalink and links to different specific versions:

For published guidelines = About -> Version history and subscriptions
For draft guidelines = Settings (gear icon) -> Publishing, version history and subscriptions

The syntax of the always updated version (permalink) is: https://app.magicapp.org/#/guideline/[guideline shortCode ID]

Example: https://app.magicapp.org/#/guideline/GnJ7bE

The syntax of the link to a specific version is: https://app.magicapp.org/#/guideline/[guideline specific ID]

Example: https://app.magicapp.org/#/guideline/1844

Image: https://help.magicapp.org/assets/239191432/Guideline%20links.png

You can also get the permalink by clicking Options on the guideline on the homepage

Image: https://help.magicapp.org/assets/239191360/Link%20to%20guideline%20from%20homepage.png

And you can also get the link to the specific version via the address in the browser window when you open the guideline

Image: https://help.magicapp.org/assets/239191414/Screenshot%202023-03-15%20at%2011.29.15%20PM.png

Sections

You can find both the permalink and links to different specific versions:

For published guidelines = link icon (top right)
For draft guidelines = Add Recommendation -> Links and widgets

The syntax of the always updated version (permalink) is: https://app.magicapp.org/#/guideline/[guideline shortCode ID]/section/[section shortCode ID]

Example: https://app.magicapp.org/#/guideline/GnJ7bE/section/jxZ7yn

The syntax of the link to a specific version is: https://app.magicapp.org/#/guideline/[guideline specific ID]/section/[section specific ID]

Example: https://app.magicapp.org/#/guideline/1844/section/19921

Recommendations links and widgets

You can find both the permalink and links to different specific versions:

For published guidelines = the (!) icon on the top right of the recommendation -> Links and widgets
For draft guidelines = Options -> Links and widgets

The syntax of the always updated version (permalink) is: https://app.magicapp.org/#/guideline/[guideline shortCode ID]/rec/[rec shortCode ID]

Example: https://app.magicapp.org/#/guideline/GnJ7bE/rec/Egl6Vj

The syntax of the link to a specific version is: https://app.magicapp.org/#/guideline/[guideline specific ID]/rec/[rec specific ID]

Example: https://app.magicapp.org/#/guideline/1844/rec/23893

The default is to have no tabs open. If you add a specific tab suffix, you can force the recommendation to open in a specific tab when user clicks the link:

/sof = Summary of Findings/Evidence tab

/da = Decision aids tab

/key = Evidence to decision tab

/rationale = Rationale tab

/practical = Practical info

Example: https://app.magicapp.org/#/guideline/GnJ7bE/rec/Egl6Vj/da - will take user to this recommendation with the Decision aids tab open.

For more details about customizing the Recommendations widget, and different ways to link to the widget, see Help article.

Summary of Findings/PICO widgets

Only users with permission to the guideline can obtain links to PICOs alone (i.e. not linked to the recommendation).

You can find both the permalink and links to different specific versions:

For published guidelines = the link icon on the top right of the recommendation -> Links and widgets
For draft guidelines = Options -> Links and widgets

The syntax of the always updated version (permalink) is: https://app.magicapp.org/widget/pico/?gId=[guideline shortCode ID]&picoId=[PICO shortCode ID]&

Example: https://app.magicapp.org/widget/pico/?gId=GnJ7bE&picoId=jWK2pj&

The syntax of the link to a specific version is: https://app.magicapp.org/widget/pico/?gId=[guideline specific ID]&picoId=[PICO specific ID]&

Example: https://app.magicapp.org/widget/pico/?gId=GnJ7bE&picoId=23821&

For more details about customizing the PICO widget, and different ways to link to the widget, see Help article.

Last Updated: 21 July 2023