Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

Artifacts Summary

Page standards status: Informative

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

CRMI Artifact Terminology Service

Capability statement for a terminology service supporting artifact authoring and evaluation use cases. A server can support more functionality than defined here, but this defines the minimum expectations.

CRMI Authoring Artifact Repository

Capability statement for a repository service supporting additional authoring and content workflow capabilities for FHIR-based knowledge artifacts above the basic ShareableArtifactRepository.

CRMI Publishable Artifact Repository

Capability statement for a repository service supporting additional publishing capabilities for FHIR-based knowledge artifacts above the basic ShareableArtifactRepository.

CRMI Shareable Artifact Repository

Capability statement for a repository service supporting minimum required capabilities to share FHIR-based artifact specifications. See the Publishable and Authoring Artifact Repository capability statements for more comprehensive support for publishing and authoring workflows.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

CRMI Approve Operation

The approve operation supports applying an approval to an existing artifact, all its children, regardless of status. The operation sets the date and approvalDate elements of the approved artifact and child artifacts, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extensions in R4) resources in the repository.

CRMI Artifact Diff Operation

Describes the differences between two knowledge artifacts in FHIR Patch format by recursively resolving dependencies to get a holistic diff.

CRMI Clone Operation

Creates a clone of a knowledge artifact and all its children.

CRMI Data Requirements Operation

Determines the effective data requirements for the artifact, including known components and dependencies, and optionally informed by a version manifest.

See $package and $data-requirements

CRMI Draft Operation

Creates a draft version of a knowledge artifact and all its children.

CRMI Extension of Value Set Expansion

The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation.

If the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. An expanded value set will be returned, or an OperationOutcome with an error message.

This CRMI Extension adds support for providing value set versions, as well as the use of a manifest (parameters or library) to provide system and value set versions for references encountered during the expansion.

CRMI Extension of Value Set based Validation

Validate that a coded value is in the set of codes allowed by a value set.

If the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. If a code is provided, either a system or inferSystem SHOULD be provided. The operation returns a result (true / false), an error message, and the recommended display for the code. When validating a code or a coding, then the code, system and version output parameters SHOULD be populated when possible. When a validating a CodeableConcept, then the codeableConcept output parameter SHOULD be populated when possible.

This CRMI Extension adds support for providing value set versions, as well as the use of a manifest (parameters or library) to provide system and value set versions for references encountered during validation of the code.

CRMI License Requirements Operation

Obtains the license and copyright information for a resource and it's dependencies. Returns a parameters resource with:

  • canonical (reference to the artifact)
  • publisher
  • copyright
  • license and license detail
CRMI Package Operation

Packages a specified canonical resource for use in a target environment, optionally including related content such as dependencies, components, and test cases and data.

See $package and $data-requirements

CRMI Profiled Operation Example

This operation definition is a copy of the CRMI Data Requirements operation but declaring conformance to the CRMI Artifact, Artifact Version Bindable, Artifact Endpoint Configurable, and Manifestable operation profiles.

CRMI Publish Operation

The CRMI publish operation processes a publishable bundle containing knowledge artifacts and their metadata.

This operation is based on the core FHIR Bundle operation but requires that the input Bundle conforms to the CRMIPublishableBundle profile. The bundle must be of type 'transaction' and must contain an ImplementationGuide resource as the first entry.

The operation enables atomic publication of related knowledge artifacts (such as Libraries, ActivityDefinitions, PlanDefinitions, Measures, etc.) along with their governing ImplementationGuide, ensuring consistent deployment and proper metadata management.

CRMI Release Operation

The release operation performs release processing, including setting the date element of the resource and pinning versions of all direct and transitive references and recording them in the manifest. Child artifacts (i.e. artifacts of which the existing artifact is composed) are also released, recursively.

CRMI Resolve

Resolves a canonical reference, returning the resource (or resources) resolved.

CRMI Review Operation

The review operation supports applying an review to an existing artifact and all its children, regardless of status. The operation sets the date and lastReviewDate elements of the reviewed artifact, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resources in the repository.

Example of a Canonical Version Bindable and Pageable Operation Definition

This operation definition is a copy of the CRMI ValueSet/$expand OperationDefinition that declares conformance to the CRMI Canonical Version Bindable and CRMI Pageable operation profiles

Get Package

Retrieves a FHIR package given the package id and version.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

CRMI Computable Library

The CRMI Computable Library profile defines the must support elements for a computable library used to support artifact logic

CRMI Computable ValueSet

Defines a computable value set as one that SHALL have an expression-based definition (i.e. a value set defined intensionally using expressions of the code systems involved) and MAY have an expansion included. The expression-based definition SHALL be represented in only one of three ways; using the compose element, using the expression extension, or using the rules-text extension to provide a step-by-step process for expanding the value set definition

CRMI Endpoint Configuration Parameters

The CRMI Endpoint Configuration Parameters Profile defines parameters used to determine an endpoint where artifact content can be accessed based on the canonical url for the artifact. See the Artifact Endpoint Configurable operation profile for more information on how these parameters are used to determine an endpoint for a given canonical reference.

CRMI Evaluation Result Parameters

The CRMI Evaluation Result Parameters Profile supports using the dataAbsentReason extension to indicate null evaluation results from operations.

CRMI Executable Library

The CRMI Execuable Library profile defines the must support elements for an executable library used to support artifact logic

CRMI Expanded ValueSet

Defines an expanded value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an expanded value set, a computable definition of the value set must be obtained to compute the updated expansion.

CRMI GroupDefinition

Represents the definition of a group of subjects, suitable for use in various contexts, such as a cohort definition, a recommendation inclusion or exclusion criteria, the members of a study, or a population criteria

CRMI ImplementationGuide

Supports the specification of expansion parameters to be used with the implementation guide

CRMI Manifest Library

A Manifest Library provides dependency version management for a collection of artifacts. The manifest is an asset-collection library whose components identify the artifacts in the collection, while the dependency relationships are used to manage version dependencies of those components.

The manifest is also used to specify expansion parameters, providing details for how value set expansion should be performed for any value sets in the collection or referenced by artifacts in the collection.

In addition, the manifest can be used to specify CQL translator options for any CQL libraries in the collection (or referenced by artifacts in the collection).

CRMI Manifest Parameters

The CRMI Manifest Parameters Profile defines the expected parameters used for representing version-pinning.

CRMI MedicationDefinition

Represents the definition of a medication, suitable for use in various contexts

CRMI MedicationKnowledge Definition

Represents the definition of medication knowledge, suitable for use in various contexts

CRMI Module Configuration Library

The CRMI Module Configuration Library profile supports configuration of the data requirements for a module for a given endpoint. This is useful to provide endpoint-specific configuration of the queries to be used to gather data to satisfy the data requirements for a given module

CRMI Module Definition Library

The CRMI Module Definition Library profile defines the must support elements for a library that communicates the effective data requirements and dependencies of an artifact (or set of artifacts). This is most commonly used as the result of a $data-requirements operation, but could also be persisted statically as a way to persist the calculation of effective data requirements for a specific artifact and input parameters

CRMI Operation Profile: Artifact Endpoint Configurable

Profile for operations where artifact endpoint configuration can be specified.

  • artifactEndpointConfiguration: Configuration information to resolve canonical artifacts
    • artifactRoute: An optional route used to determine whether this endpoint is expected to be able to resolve artifacts that match the route (i.e. start with the route, up to and including the entire url)
    • endpointUri: The URI of the endpoint, exclusive with the endpoint parameter
    • endpoint: An Endpoint resource describing the endpoint, exclusive with the endpointUri parameter

Processing semantics:

Create a canonical-like reference (e.g. {canonical.url}|{canonical.version} or similar extensions for non-canonical artifacts).

  • Given a single artifactEndpointConfiguration
    • When artifactRoute is present
      • And artifactRoute starts with canonical or artifact reference
      • Then attempt to resolve with endpointUri or endpoint
    • When artifactRoute is not present
      • Then attempt to resolve with endpointUri or endpoint
  • Given multiple artifactEndpointConfigurations
    • Then rank order each configuration (see below)
    • And attempt to resolve with endpointUri or endpoint in order until resolved

Rank each artifactEndpointConfiguration such that:

  • if artifactRoute is present and artifactRoute starts with canonical or artifact reference: rank based on number of matching characters
  • if artifactRoute is not present: include but rank lower

NOTE: For evenly ranked artifactEndpointConfigurations, order as defined in the OperationDefinition.

CRMI Operation Profile: Artifact Operation

Profile for knowledge artifact operations.

This establishes input parameters when the operation is involked at the resource type level. The parameters are used to identify or specify the resource for the operation.

  • url: artifact URL* for the resource
  • version: artifact version* for the resource
  • identifier: business identifier for the resource
  • resource: instance of a canonical resource

*The artifact URL for canonical resources is .url, for non-canonical resources, it is the extension artifact-url. The version for canonical resources is .version, for non-canonical resources it is the extension artifact-version.

NOTE: When invoking canonical operations using any combination of url, version, and identifier:

  • if there is one-and-only-one matching resource, the operation should apply, otherwise an error state.
  • if resource is specified then url, version, and identifier should be ignored.
CRMI Operation Profile: Artifact Version Bindable

Operation where default artifact version(s) can be specified.

NOTE: Artifacts include FHIR Canonical resources and the resources specified as non-canonical resources, such as: Medication, Substance, MedicationKnowledge, and Group.

  • artifactVersion: Specifies a version to use for a artifact resource if the artifact referencing the resource does not already specify a version. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56
  • checkArtifactVersion: Edge Case: Specifies a version to use for a artifact resource. If the artifact referencing the resource specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56
  • forceArtifactVersion: Edge Case: Specifies a version to use for a artifact resource. This parameter overrides any specified version in the artifact (and any artifacts it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly.
CRMI Operation Profile: Canonical Version Bindable

Operation where default canonical version(s) can be specified

NOTE: This profile is here for backwards compatibility, see ArtifactVersionBindableOperation profile as a successor.

  • canonicalVersion: Specifies a version to use for a canonical resource if the artifact referencing the resource does not already specify a version. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56
  • checkCanonicalVersion: Edge Case: Specifies a version to use for a canonical resource. If the artifact referencing the resource specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56
  • forceCanonicalVersion: Edge Case: Specifies a version to use for a canonical resource. This parameter overrides any specified version in the artifact (and any artifacts it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly.
CRMI Operation Profile: Manifestable

Operation where default manifest to resolve canonicals can be specified

  • manifest: Canonical reference to a Library resource where related-artifacts are used to define the versions of canonical resources.
CRMI Operation Profile: Pageable

Operation that is pageable

This establishes input parameters when the operation might return paging.

  • offset: Pagination offset
  • count: Number of items per page
CRMI Publishable ActivityDefinition

Supports declaration of the ActivityDefinition metadata required by HL7 and other organizations that share and publish activity definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable Bundle

A publishable bundle is a Bundle resource that represents a collection of FHIR resources that can be published as a cohesive unit.

The bundle must be of type 'transaction' and must contain an ImplementationGuide resource as the first entry. This ensures that the bundle represents a complete, publishable package with proper metadata and resource organization defined by the implementation guide.

This profile supports the distribution and management of knowledge artifacts as atomic units, enabling consistent publication and deployment of related clinical decision support resources, quality measures, and other healthcare knowledge content.

CRMI Publishable CapabilityStatement

Supports declaration of the CapabilityStatement metadata required by HL7 and other organizations that share and publish capability statements with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable CodeSystem

Defines and enforces the minimum expectations for publication and distribution of a code system, typically as part of an artifact repository or implementation guide publication

CRMI Publishable ConceptMap

Defines and enforces the minimum expectations for publication and distribution of a concept map, typically as part of an artifact repository or implementation guide publication

CRMI Publishable GraphDefinition

Supports declaration of the GraphDefinition metadata required by HL7 and other organizations that share and publish graph definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable Group

Supports declaration of the group metadata required by HL7 and other organizations that share and publish groups with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable ImplementationGuide

Supports declaration of the ImplementationGuide metadata required by HL7 and other organizations that share and publish implementation guides with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable Library

Supports declaration of the library metadata required by HL7 and other organizations that share and publish libraries with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable Measure

Supports declaration of the Measure metadata required by HL7 and other organizations that share and publish measures with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable Medication

Supports declaration of the medication metadata required by HL7 and other organizations that share and publish medications with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable MedicationKnowledge

Supports declaration of the medication knowledge metadata required by HL7 and other organizations that share and publish medication knowledge with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable NamingSystem

Defines and enforces the minimum expectations for publication and distribution of a naming system, typically as part of an artifact repository or implementation guide publication

CRMI Publishable OperationDefinition

Supports declaration of the OperationDefinition metadata required by HL7 and other organizations that share and publish operation definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable PlanDefinition

Supports declaration of the PlanDefinition metadata required by HL7 and other organizations that share and publish plandefinitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable Questionnaire

Supports declaration of the Questionnaire metadata required by HL7 and other organizations that share and publish questionnaires with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable SearchParameter

Supports declaration of the SearchParameter metadata required by HL7 and other organizations that share and publish search parameters with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable StructureDefinition

Supports declaration of the StructureDefinition metadata required by HL7 and other organizations that share and publish structure definitions with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable StructureMap

Supports declaration of the StructureMap metadata required by HL7 and other organizations that share and publish structure maps with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable Substance

Supports declaration of the substance metadata required by HL7 and other organizations that share and publish substances with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable TerminologyCapabilities

Supports declaration of the TerminologyCapabilities metadata required by HL7 and other organizations that share and publish terminology capabilities with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.

CRMI Publishable ValueSet

Defines and enforces the minimum expectations for publication and distribution of a value set, typically as part of an artifact repository or implementation guide publication

CRMI Shareable ActivityDefinition

Enforces the minimum information set for the activity definition metadata required by HL7 and other organizations that share and publish activity definitions

CRMI Shareable CapabilityStatement

Enforces the minimum information set for the capabilitystatement metadata required by HL7 and other organizations that share and publish capability statements

CRMI Shareable CodeSystem

Enforces the minimum information set for the code system metadata required by HL7 and other organizations that share and publish code systems

CRMI Shareable ConceptMap

Enforces the minimum information set for the concept map metadata required by HL7 and other organizations that share and publish concept maps

CRMI Shareable GraphDefinition

Enforces the minimum information set for the graph definition metadata required by HL7 and other organizations that share and publish graph definitions

CRMI Shareable Group

Enforces the minimum information set for the group metadata required by HL7 and other organizations that share and publish groups

CRMI Shareable ImplementationGuide

Enforces the minimum information set for the implementation guide metadata required by HL7 and other organizations that share and publish implementation guides

CRMI Shareable Library

Enforces the minimum information set for the library metadata required by HL7 and other organizations that share and publish libraries

CRMI Shareable Measure

Enforces the minimum information set for the measure metadata required by HL7 and other organizations that share and publish measures

CRMI Shareable Medication

Enforces the minimum information set for the medication metadata required by HL7 and other organizations that share and publish medications

CRMI Shareable MedicationKnowledge

Enforces the minimum information set for the medication knowledge metadata required by HL7 and other organizations that share and publish medication knowledge

CRMI Shareable NamingSystem

Enforces the minimum information set for the naming system metadata required by HL7 and other organizations that share and publish naming systems

CRMI Shareable OperationDefinition

Enforces the minimum information set for the operation definition metadata required by HL7 and other organizations that share and publish operation definitions

CRMI Shareable PlanDefinition

Enforces the minimum information set for the plan definition metadata required by HL7 and other organizations that share and publish plan definitions

CRMI Shareable Questionnaire

Enforces the minimum information set for the questionnaire metadata required by HL7 and other organizations that share and publish questionnaires

CRMI Shareable SearchParameter

Enforces the minimum information set for the search parameter metadata required by HL7 and other organizations that share and publish search parameters

CRMI Shareable StructureDefinition

Enforces the minimum information set for the structure definition metadata required by HL7 and other organizations that share and publish structure definitions

CRMI Shareable StructureMap

Enforces the minimum information set for the structure map metadata required by HL7 and other organizations that share and publish structure maps

CRMI Shareable Substance

Enforces the minimum information set for the substance metadata required by HL7 and other organizations that share and publish substances

CRMI Shareable TerminologyCapabilities

Enforces the minimum information set for the terminology capabilities metadata required by HL7 and other organizations that share and publish terminology capabilities

CRMI Shareable ValueSet

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

CRMI Software System Device

The Software System device profile is used to capture software details about the various systems used in authoring, testing, packaging, or evaluation of a knowledge artifact

CRMI SubstanceDefinition

Represents the definition of a substance, suitable for use in various contexts

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

CRMI Artifact Signature Extension

This extension is used to sign FHIR knowledge artifacts, ensuring their integrity and authenticity.

CRMI Configuration Endpoint

Which endpoint this module configuration is for

CRMI Configuration For

Which artifact this module configuration is for

CRMI Effective Data Requirements

A module definition library that contains the effective data requirements for an artifact (i.e. the calculated data requirements for the expressions directly referenced by the artifact structure).

CRMI Endpoint Configuration

Specifies a set of configuration parameters that can be used to provide canonical-based routing for content, using the parameters specified in the ArtifactEndpointConfigurable profile.

CRMI Endpoint Supports POST

Indicates whether the endpoint of the configuration library on which it appears supports using a POST for search

CRMI License Detail Extension

This extension provides detailed information about the license, including the URL to the license text and the license type.

CRMI License Extension

This extension is used to indicate the license information for a FHIR resource.

CRMI Reference Source

Specifies the source of an artifact reference when it is being recorded as a dependency as part of manifest library.

CRMI Software System

Specifies the software systems used in the packaging and testing of knowledge artifacts. Specifically to support explicitly stating which versions of the various software components were used in the authoring, packaging, and testing.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Artifact Resource Types

FHIR canonical plus knowledge artifact resource types.

CRMI Release Experimental Behavior

Behaviors of 'experimentalBehavior' parameter application in the $release operation.

CRMI Release Version Behavior

Behaviors of 'version' parameter application in the $release operation.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CRMI Release Experimental Behavior Codes

Behaviors of 'experimentalBehavior' parameter application in the $release operation.

CRMI Release Version Behavior Codes

Behaviors of 'version' parameter application in the $release operation.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

ANC Cohort

Cohort definition for antenatal care

ANC.B5 Quick check (Publishable Example)

Quick check questionnaire

ANC.B5 Quick check (Shareable Example)

Quick check questionnaire

ANC.DT.01 Danger signs (Publishable Example)

Before each contact, during the Quick Check, the health worker should check whether the woman has any of the danger signs listed here – if yes, she should be referred to the hospital urgently; if no, the normal contact should be continued as normal

ANC.DT.01 Danger signs (Shareable Example)

Before each contact, during the Quick Check, the health worker should check whether the woman has any of the danger signs listed here – if yes, she should be referred to the hospital urgently; if no, the normal contact should be continued as normal

ANC.IND.01 Percentage of pregnant women with first ANC contact in the first trimester (Publishable Example)

Percentage of pregnant women with first ANC contact in the first trimester (before 12 weeks of gestation)

ANC.IND.01 Percentage of pregnant women with first ANC contact in the first trimester (Shareable Example)

Percentage of pregnant women with first ANC contact in the first trimester (before 12 weeks of gestation)

ANCM Activity Codes (Shareable Example)

Set of codes representing all activities used in the implementation guide

ANCM Concept Codes (Publishable Example)

Set of codes representing all concepts used in the implementation guide

ANCM Danger Signs Package

This library is an example of an artifact manifest for the DT-01 PlanDefinition from the ANC-Mini IG.

CQF Tooling Device

Example of a Software System Device instance for describing tooling that was used to process artifacts. This resource is typically referenced from the crmi-softwaresystem extension

Danger Signs - Central cyanosis Codes (Example)

Codes representing possible values for the Danger Signs - Central cyanosis element

Danger Signs - No danger signs Codes (Example)

Codes representing possible values for the Danger Signs - No danger signs element

Danger signs (Publishable Example)

Before each contact, the health worker should check whether the woman has any of the danger signs listed here – if yes, she should refer to the hospital urgently; if no, she should continue to the normal contact

Danger signs Codes (Example)

Codes representing possible values for the Danger signs element

Danger signs Codes Grouper (Computable Example)

Group Valueset with codes representing possible values for the Danger signs Codes Grouper element

Danger signs Codes Grouper (Expanded Example)

Group Valueset with codes representing possible values for the Danger signs Codes Grouper element

Danger signs Codes Grouper (Publishable Example)

Group Valueset with codes representing possible values for the Danger signs Codes Grouper element

Example Endpoint Configuration Parameters

Example Parameters resource demonstrating a possible endpoint configuration for accessing content in tx.fhir.org and the Value Set Authority Center.

Example Evaluation Result Parameters

Example Parameters resource demonstrating the use of data-absent-reason extension to indicate a null evaluation result.

Example Group Definition

Example Group Definition illustrating the use of an expression to define group membership.

Example Logic Library - Module Definition

This library is used as an example module definition in the FHIR Quality Measure Implementation Guide

Example Manifest Parameters

Example Parameters resource demonstrating an input manifest parameters used to support predictable expansion throughout a measure development cycle.

Example MeasureReport

Example MeasureReport illustrating use of MeasureReport as a test case.

Example Medication Definition

Example of a Medication resource illustrating use as a non-canonical artifact.

Example MedicationKnowledge Definition

Example of a MedicationKnowledge resource illustrating use as a non-canonical artifact.

Example Publishable Bundle

This example demonstrates a publishable bundle containing an ImplementationGuide as the first entry, followed by related knowledge artifacts including a Library and ActivityDefinition.

The bundle represents a complete sepsis detection and management package that can be published and deployed as an atomic unit to healthcare systems.

Example Publishable TerminologyCapabilities

Example Publishable Terminology Capabilities to describe an environment capable of expanding LOINC value sets, but not RxNORM value sets

Example Shareable TerminologyCapabilities

Example Shareable Terminology Capabilities to describe an environment capable of expanding LOINC value sets, but not RxNORM value sets

Example Substance Definition

Example of a Substance resource illustrating use as a non-canonical artifact.

Example TestCase Group

Example Group illustrating use of the cqf-testArtifact extension to build a set of test data for an artifact.

ExampleLicensedLibrary

This example demonstrates how licensing information can be attached to FHIR knowledge artifacts using CRMI extensions.

The library shows two properties to artifact licensing:

  1. License Code: A standardized code (like 'not-open-source') that provides machine-readable license classification
  2. License Detail: Human-readable markdown text that contains the full license terms, contact information, and usage restrictions

This approach enables both automated license compliance checking through standardized codes and detailed legal clarity through comprehensive license text.

ExampleSignatureLibrary

This example now demonstrates how to properly attach an artifact signature to a FHIR Library resource using the CRMI signature extension.

The generated SHA256 checksum of the current resource (which excludes id, text, and meta), in minified JSON form is:

892c98e8660c3b84f88cffc4759880ea6f73afa9f58a5ee5dd2f8b7c48250dca

The signature data value after base64 decoding is a JWT:

eyJhbGciOiJSUzM4NCJ9.eyJpc3MiOiJodHRwczovL2xvY2FsaG9zdDozMDAwL29pZGMiLCJoYXNoIjoiODkyYzk4ZTg2NjBjM2I4NGY4OGNmZmM0NzU5ODgwZWE2ZjczYWZhOWY1OGE1ZWU1ZGQyZjhiN2M0ODI1MGRjYSJ9.T581_ZkQee7RnJpePnApDIgWtHCO6GUFltHF3riM0wEEAMuVK8X63OrBZpRMCFZWwJ9_RQk3Jo9q4Tyu5WxnZaFxyH0cDCs21gFuCtUanRf4jep2ZfShjVjmm90AGyAzz6EeTodpWyNL48Js__ZSmK8HahkFos5DWZdi93BZalOPvR-pAnzKgxyrrkdmLFZBjKC6drzqhfTyTY0P2yLZV0x6X3btvkdcci8_tqKDl8xz84Gut4iHr0fivP7CbzBoIO6Dlw1gScFWaE9ATRDvkTnSYu3JVptMZo4xgKhrL3ZQktrQZm1CIQ8tnMn5hCdT7W-DysejxxH9t128FYBA1Q

The decoded JWT payload contains the following fields:

  • iss: The issuer of the signature, which is the CRMI server URL.
  • hash: The SHA256 checksum of the resource in minified JSON form.
    {
    "iss": "https://localhost:3000/oidc",
    "hash": "892c98e8660c3b84f88cffc4759880ea6f73afa9f58a5ee5dd2f8b7c48250dca"
    }
    

The signature is created using the private key of the CRMI server, ensuring the integrity and authenticity of the resource. Clients can verify JWT signature using the public key provided by the CRMI server, and then verify the SHA256 checksum against the resource's content to ensure it has not been altered.

FHIR Common (Computable Example)

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

FHIR Common (Example)

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

FHIR Common (Executable Example)

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

FHIR Common (Publishable Example)

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

FHIR Common (Shareable Example)

This library defines terminologies and functions commonly used in FHIR-based CQL artifacts.

ImplementationGuide Example

This implementation guide demonstrates the use of the expansion parameters extension

Module Configuration Example Library for Recommendation 10 (Endpoint-specific prefetch configuration)

This library is used to populate the prefetch template for Recommendation 10 (Endpoint-specific)

Outcome Manifest for ANCM Danger Signs Package

This library is the outcome manifest for the example ANCM Danger Signs Package.

Patient Example 1

Example patient 1 in the test case group

Patient Example 2

Example patient 2 in the test case group

Publishable ActivityDefinition Example

Example Publishable Activity Definition for a recommendation to order a medication

Publishable Capability Statement Example

Basic conformance statement for a Library Evaluation Service. A server can support more functionality than defined here, but this is the minimum amount

Publishable Concept Map Example

A mapping between the FHIR and HL7 v3 AddressUse Code systems

Publishable ImplementationGuide Example

This implementation guide demonstrates end-to-end capabilities for computable clinical practice guidelines following the World Health Organization SMART IG approach

Publishable Medication Example

Example of a Medication resource as a publishable non-canonical artifact.

Publishable MedicationKnowledge Example

Example of a MedicationKnowledge resource as a publishable non-canonical artifact.

Publishable OperationDefinition Example

Limited implementation of the Populate Questionnaire implementation

Publishable StructureMap Example

Example Structure Map

Publishable Substance Example

Example of a Substance resource as a publishable non-canonical artifact.

PublishableGraphDefinitionExample

Example of a Publishable GraphDefinition

PublishableGroupExample

The inclusion criteria for determining applicability of antenatal care

PublishableSearchParameterExample

Search by resource identifier - e.g. same as the read interaction, but can return included resources

SNOMEDCTExample

SNOMED CT is a concept-based, scientifically validated terminology that provides a unique and permanent concept identifier that can be included in multiple HL7 data types including CD and CE. The concepts are managed to avoid "semantic drift" so the meaning remains constant. If the concept is found to be ambiguous or the meaning changes, the concept is inactivated but still retained and the identifier is never reused. SNOMED CT's concepts are interrelated hierarchically and using description logic. SNOMED CT concepts have a unique "fully-specified name", a preferred term, and, optionally, synonyms. The description languages include English and Spanish.

SNOMEDCTShareable

SNOMED CT is a concept-based, scientifically validated terminology that provides a unique and permanent concept identifier that can be included in multiple HL7 data types including CD and CE. The concepts are managed to avoid "semantic drift" so the meaning remains constant. If the concept is found to be ambiguous or the meaning changes, the concept is inactivated but still retained and the identifier is never reused. SNOMED CT's concepts are interrelated hierarchically and using description logic. SNOMED CT concepts have a unique "fully-specified name", a preferred term, and, optionally, synonyms. The description languages include English and Spanish.

Shareable ActivityDefinition Example

Example Shareable Activity Definition for a recommendation to order a medication

Shareable ActivityDefinition Example Artifact Reference

Example Shareable Activity Definition for a recommendation to order a medication. The medication uses the artifact-uriReference extension to a corresponding medication identified by artifact-url and artifact-version extensions

Shareable Capability Statement Example

Basic conformance statement for a Library Evaluation Service. A server can support more functionality than defined here, but this is the minimum amount

Shareable Concept Map Example

A mapping between the FHIR and HL7 v3 AddressUse Code systems

Shareable ImplementationGuide Example

This implementation guide demonstrates end-to-end capabilities for computable clinical practice guidelines following the World Health Organization SMART IG approach

Shareable Medication Example

Example of a Medication resource as a shareable non-canonical artifact.

Shareable MedicationKnowledge Example

Example of a MedicationKnowledge resource as a shareable non-canonical artifact.

Shareable OperationDefinition Example

Limited implementation of the Populate Questionnaire implementation

Shareable Structure Map Example

Example Structure Map

Shareable Substance Example

Example of a Substance resource as a shareable non-canonical artifact.

ShareableGraphDefinitionExample

Example of a Shareable GraphDefinition

ShareableGroupExample

The inclusion criteria for determining applicability of antenatal care

ShareableSearchParameterExample

Search by resource identifier - e.g. same as the read interaction, but can return included resources

Specific health concern(s) (Shareable Example)

If the woman came to the facility with a specific health concern, select the health concern(s) from the list

Specific health concern(s) Codes (Shareable Example)

Codes representing possible values for the Specific health concern(s) element

eCQM Annual Update 2024

This library is an example initial draft of a version manifest (also referred to as an expansion profile) that specifies expansion rules for a set of value sets used for a collection of measures authored, published, and distributed together, and that are executed with a collective set of expectations documented as part of the release, especially version dependencies for code systems used in value sets referenced by the measures, to ensure predictable expansion of the value sets used to evaluate the measures.

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

Input Expansion Parameters

The input expansion parameters resource for this implementation guide, specifying SNOMED Edition and version.