Opening a Resource on CKM Start

Owned by Sebastian Garde
Last updated: 16-Nov-2015
1 min read

CKM resources such as archetypes, templates and termsets can directly be opened via direct link. This is useful for example to directly point somebody to a resource and is also useful for integration purposes with other tools.

You can see the cid (citeable identifier) of a resource for example on the Email Colleague Tab for a resource.

Simple

http://www.openehr.org/ckm#showArchetype_cidArchetype

http://www.openehr.org/ckm#showTemplate_cidTemplate

http://www.openehr.org/ckm#showTermset_cidTermset

The cidArchetype, cidTemplate, cidTermset are the citeable identifiers of the resource.

For example: http://www.openehr.org/ckm#showArchetype_1013.1.130 for the Blood pressure archetype.

Specify Revision

In some cases it is desired to link to a specific revision of a resource. By default, the latest revision is retrieved.

http://www.openehr.org/ckm#showArchetype_cidArchetype_revision

for example: http://www.openehr.org/ckm#showArchetype_1013.1.130_1

Similar for
#showTemplate and #showTermset

Actions

Sometimes it is also desirable to specify the Action, i.e what will be shown for the resource. Usually a simple view or a tabbed view is shown as a default for the resource, but you may for example want to link to discussions of a resource.

http://www.openehr.org/ckm#showArchetype_cidArchetype_action
or http://www.openehr.org/ckm#showArchetype_cidArchetype_revision_action

Same for showTemplate and showTermset.

Actions available for all Resources

  • SIMPLE
  • REVISIONHISTORY
  • COMMENTS (login required)
  • RESOURCECENTRE (login required)
  • WATCHES (login required)
  • DOWNLOAD
  • CLASSIFICATION (login required)
  • EMAILLINK (login required)
  • RELATEDRESOURCES

Additional Actions for Archetypes

  • TABBED
  • ADL
  • XML
  • MINDMAP
  • REVIEWSCONTENT (login required)
  • REVIEWSTERMINOLOGY (login required)
  • REVIEWSTRANSLATION (login required)
  • VALIDATION (login required)
  • STATUS

http://www.openehr.org/ckm#showArchetype_1013.1.130_1_DOCUMENTATION

Additional Actions for Templates

  • SIMPLE
  • OET
  • OPT
  • MINDMAP

Additional Actions for Termsets

  • SIMPLE
  • QUERYXML
  • QUERYRENDERED

Get Archetype by Archetype Id

http://www.openehr.org/ckm#showArchetypeById_ArchetypeId_ACTION

For example:
http://www.openehr.org/ckm#showArchetypeById_openEHR-EHR-OBSERVATION.blood_pressure.v1_DOCUMENTATION

Please note that the spelling of the archetype needs to be exact, including upper and lower case.

If the archetype cannot be found, an error message is displayed.

If the user requested an action that requires her/him to be signed in, a sign-in screen is displayed first (unless the user is already signed in)