CRMI Artifact Terminology Service

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

Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: CRMI Artifact Terminology Service

Official URL: http://hl7.org/fhir/uv/crmi/CapabilityStatement/crmi-artifact-terminology-service		Version: 2.0.0-ballot
Standards status: Trial-use	Maturity Level: 4	Computable Name: CRMIArtifactTerminologyService
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.13.3

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.

Raw OpenAPI-Swagger Definition file | Download

Implementation Guide Version: 2.0.0-ballot
FHIR Version: 4.0.1
Supported Formats: json, xml
Published on: 2025-10-06 17:05:19+0000
Published by: HL7 International / Clinical Decision Support

Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi

FHIR RESTful Capabilities

Mode: `server`

RESTful Artifact Terminology Server

Security

Enable CORS: yes

Security services supported: Certificates

Summary of System-wide Operations

Conformance	Operation	Documentation
SHALL	$expand
SHALL	$lookup
SHALL	$validate-code
SHALL	$package
SHOULD	$expand
SHOULD	$expand

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

The relevant profiles (if any)
The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
The required, recommended, and some optional search parameters (if any).
The linked resources enabled for _include
The other resources enabled for _revinclude
The operations on the resource (if any)

Resource Type	Profile	R	S	Searches
CodeSystem	http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem Additional supported profiles: CRMI Publishable CodeSystem	Y	Y	url, version, identifier, name, title, description, status, code
ValueSet	http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablevalueset Additional supported profiles: CRMI Computable ValueSet CRMI Expanded ValueSet CRMI Publishable ValueSet	Y	Y	date, name, title, identifier, description, status, url, version, code, context, context-type, context-type-quantity, context-type-value
Library	http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary Additional supported profiles: CRMI Publishable Library CRMI Computable Library CRMI Executable Library CRMI Manifest Library CRMI Module Definition Library	Y	Y	date, name, title, identifier, description, status, url, version, composed-of, depends-on

Resource Conformance: SHALL CodeSystem

Base System Profile
CRMI Shareable CodeSystem

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CRMI Publishable CodeSystem

Interaction summary

SHALL support
read
Read allows clients to get the definitions and details of supported code systems

search-type
Search allows clients to search for supported code systems

Search Parameters

Conformance	Parameter	Type
SHALL	url	`uri`
SHALL	version	`token`
SHALL	identifier	`token`
SHALL	name	`string`
SHALL	title	`string`
SHALL	description	`string`
SHALL	code	`token`
SHOULD	status	`token`

Resource Conformance: SHALL ValueSet

Base System Profile
CRMI Shareable ValueSet

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CRMI Computable ValueSet
CRMI Expanded ValueSet
CRMI Publishable ValueSet

Interaction summary

SHALL support
read
Read allows clients to get the logical definitions of the value sets

search-type
Search allows clients to find value sets on the server

Search Parameters

Conformance	Parameter	Type
SHALL	date	`date`
SHALL	name	`string`
SHALL	title	`string`
SHALL	identifier	`token`
SHALL	description	`string`
SHALL	status	`token`
SHALL	url	`uri`
SHALL	version	`token`
SHALL	code	`token`
SHOULD	context	`token`
SHOULD	context-type	`token`
SHOULD	context-type-quantity	`composite`
SHOULD	context-type-value	`composite`

Resource Conformance: SHALL Library

Base System Profile
CRMI Shareable Library

Profile Conformance
SHALL

Reference Policy

Supported Profiles

CRMI Publishable Library
CRMI Computable Library
CRMI Executable Library
CRMI Manifest Library
CRMI Module Definition Library

Interaction summary

SHALL support
read
Read allows clients to get the logical definitions of the available artifact libraries

search-type
Search allows clients to find artifact libraries on the server

Search Parameters

Conformance	Parameter	Type
SHALL	date	`date`
SHALL	name	`string`
SHALL	title	`string`
SHALL	identifier	`token`
SHALL	description	`string`
SHALL	status	`token`
SHALL	url	`uri`
SHALL	version	`token`
SHALL	composed-of	`reference`
SHALL	depends-on	`reference`

IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-10-06
Links: Table of Contents | QA Report | Version History | | Propose a change

CapabilityStatement: CRMI Artifact Terminology Service