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

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

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

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.

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

See $crmi.package and $crmi.data-requirements

TODO: Add example of the use-case that will do dependency tracing, similar to $package but returns only the information and not the actual resources.

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.

Packages a specified canonical resource with dependencies.

See $package and $data-requirements

Retrieves a FHIR package given the package id and version.

The release operation supports updating the status of an existing draft artifact to active. The operation sets the date element of the resource and pins versions of all direct and transitive references and records them in the program’s manifest. Child artifacts (i.e. artifacts of which the existing artifact is composed) are also released, recursively.

The CRMI Capability Statement Profile enables capability statements to express supported CQL versions.

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

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

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

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

Defines an executable 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 executable value set, a computable definition of the value set must be obtained to compute the updated expansion.

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

Represents the definition of a location, suitable for use in various contexts, such as a facility definition

Defines and supports the definition of a manifest used to establish specific versions of dependencies used in a collection of knowledge artifacts

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

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

The CRMI Model Information Library profile defines the must support elements for a computable Model Definition library used to support declaration and distribution of CQL ModelInfo such as the FHIR Model Info 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

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

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.

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.

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

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

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.

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

When the artifact was approved by publisher.

A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

When the artifact is expected to be used.

Whether or not the referenced artifact is owned by the referencing artifact.

When the artifact was last reviewed by the publisher.

Release notes for a release of an artifact.

A human-friendly release label assigned for the version.

Describes the clinical usage of the artifact.

Indicates the mechanism used to compare versions to determine which is more current.

Describes the versioning policy of the artifact.

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).

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.

Provides a default value for a parameter definition.

Specifies a term and its associated definition.

Specifies the expansion parameters that should be used to expand the ValueSet, or any ValueSets in the Library (or referenced by components of the Library).

A FHIR Query URL pattern that corresponds to the data specified by the data requirement. If multiple FHIR Query URLs are present, they each contribute to the data specified by the data requirement (i.e. the union of the results of the FHIR Queries represents the complete data for the data requirement). This is not a resolveable URL, in that it will contain 1) No base canonical (i.e. it’s a relative query), and 2) Parameters using tokens that are delimited using double-braces and the context parameters are dependent solely on the subjectType, according to the following: Patient: context.patientId, Practitioner: context.practitionerId, Organization: context.organizationId, Location: context.locationId, Device: context.deviceId.

Specifies whether the related artifact is defining a primary citation for the artifact (i.e. one that should appear in the narrative for the artifact specification.

Allows a given data requirement to be identified as “selective”, meaning that it can be used as an additive criteria to filter a population. A selective data requirement is guaranteed to define a subset (not necessarily proper) of the initial population of an artifact. If multiple data requirements are marked selective, they all apply (i.e. AND semantics).

An OperationOutcome that contains any information, warning, and/or error messages that were generated while processing an operation such as $evaluate or $prepopulate.

Specifies whether the profile should be included in the model info constructed for an artifact collection such as an implementation guide. If this extension is not present, included is true by default for resources and profiles, but not data types (unless they are indirectly referenced by included resources or profiles). Note that even if isIncluded is false for a resource or profile, it will still be included in model info if it is a required dependency of some other included resource, profile, or data type.

Specifies whether the class constructed for the profile should be marked as retrievable in the model info (meaning whether or not it can appear as the target of a retrieve expression). If this value is not specified, retrievable is true for resources and false for data types.

Specifies the label for the class constructed in the model info for the profile (i.e. an alternative, user-friendly name that can be used as the identifier for the class in CQL expressions).

Specifies the primary code path for the class constructed in the model info for the profile (i.e. the path to the code-valued element on the resource that should be used as the default terminology filter when no terminology target is specified in a CQL retrieve).

Specifies the settings to be used for constructing modelinfo from profile definitions.

A logical reference (e.g. a reference to ValueSet.url) to a value set/version that identifies a set of possible coded values representing activities that were not requested, ordered, or performed.

Specifies the type of resource the canonical references.

Defines the scope of an artifact as a string of the form {namespace-name}[@{namespace-uri}]. Namespace name shall be a valid NPM package id, and namespace uri shall be a valid uri. For FHIR implementation guides, scope is inferred using the package id and the base canonical. e.g. fhir.cqf.common@http://fhir.org/guides/cqf/common. This extension can be used on Implementation Guides, Libraries, on any knowledge artifact, to declare the scope of the artifact. In the absence of an explicit scope declaration, the scope of an artifact is inferred based on the IG in which the artifact is defined.

Allows additional value-based filters to be specified as part of a data requirement.

The type of artifact comment (documentation, review, guidance)

The versioning policy of an artifact or set of artifacts (metadata or strict)

A capability afforded by a knowledge artifact, e.g. shareable, computable, publishable, executable

A knowledge representation level, narrative, semi-structured, structured, and executable

The type of comparator operator to use

The versioning policy of an artifact (metadata, strict)

Behaviors of ‘version’ parameter application in the $release operation.

A capability afforded by a knowledge artifact, e.g. shareable, computable, publishable, executable

A knowledge representation level, narrative, semi-structured, structured, and executable

The type of software system (authoring, testing, tooling, evaluation)

Cohort definition for antenatal care

Behaviors of ‘version’ parameter application in the $release operation.

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

The type of software system (authoring, testing, tooling, evaluation)

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

Codes representing possible values for the Danger signs element

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

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

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

Example of a SoftwareSystemDevice indicating what tooling was used to process knowledge artifact content

Example of a reusable definition of a CareTeam

Example of a GroupDefinition

Example of a reusable definition of a Location

Example of a reusable medication definition

Example of a reusable MedicationKnowledge definition

Example of a reusable PractitionerRole definition

Example of a reusable Substance definition

Example patient

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

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

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

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

Model definition for USCore (v3.1.0) Model

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

Example of an observation illustrating use of the notDoneValue set extension to communicate negation

Example Publishable Activity Definition for a recommendation to order a medication

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

Set of codes representing all concepts used in the implementation guide

A mapping between the FHIR and HL7 v3 AddressUse Code systems

Example of a Publishable GraphDefinition

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

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

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

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.

Limited implementation of the Populate Questionnaire implementation

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

TODO: description goes here

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

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

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

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

Example of a Parameters resource used to specify ModelInfo generation settings

Example MeasureReport illustrating return of messages encountered during evaluation

Example Shareable Activity Definition for a recommendation to order a medication

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

Set of codes representing all activities used in the implementation guide

A mapping between the FHIR and HL7 v3 AddressUse Code systems

Example of a Shareable GraphDefinition

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

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

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

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.

Limited implementation of the Populate Questionnaire implementation

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

TODO: description goes here

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

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

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

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