XIG: CapabilityStatement/crmi-artifact-terminology-service

FHIR IG Statistics: CapabilityStatement/crmi-artifact-terminology-service

Package	hl7.fhir.uv.crmi
Resource Type	CapabilityStatement
Id	crmi-artifact-terminology-service
FHIR Version	R4
Source	http://hl7.org/fhir/uv/crmi/https://build.fhir.org/ig/HL7/crmi-ig/CapabilityStatement-crmi-artifact-terminology-service.html
URL	http://hl7.org/fhir/uv/crmi/CapabilityStatement/crmi-artifact-terminology-service
Version	2.0.0-ballot
Status	active
Date	2025-08-01T16:38:28+00:00
Name	CRMIArtifactTerminologyService
Title	CRMI Artifact Terminology Service
Realm	uv
Authority	hl7
Description	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.
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

ImplementationGuide
hl7.fhir.uv.crmi	Canonical Resource Management Infrastructure Implementation Guide

OperationDefinition
crmi-package	CRMI Package
crmi-valueset-expand	CRMI Extension of Value Set Expansion
crmi-valueset-validate-code	CRMI Extension of Value Set based Validation

StructureDefinition
crmi-computablelibrary	CRMI Computable Library
crmi-computablevalueset	CRMI Computable ValueSet
crmi-executablelibrary	CRMI Executable Library
crmi-expandedvalueset	CRMI Expanded ValueSet
crmi-manifestlibrary	CRMI Manifest Library
crmi-moduledefinitionlibrary	CRMI Module Definition Library
crmi-publishablecodesystem	CRMI Publishable CodeSystem
crmi-publishablelibrary	CRMI Publishable Library
crmi-publishablevalueset	CRMI Publishable ValueSet
crmi-shareablecodesystem	CRMI Shareable CodeSystem
crmi-shareablelibrary	CRMI Shareable Library
crmi-shareablevalueset	CRMI Shareable ValueSet

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement crmi-artifact-terminology-service

CRMI Artifact Terminology Service

Implementation Guide Version: 2.0.0-ballot
FHIR Version: 4.0.1
Supported Formats: json, xml
Supported Patch Formats:
Published on: 2025-08-01 16:38:28+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 Interactions

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`

Operations

Use

Source

{
  "resourceType": "CapabilityStatement",
  "id": "crmi-artifact-terminology-service",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-supported-system",
      "valueUri": "http://loinc.org"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 4,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/crmi/CapabilityStatement/crmi-artifact-terminology-service",
  "version": "2.0.0-ballot",
  "name": "CRMIArtifactTerminologyService",
  "title": "CRMI Artifact Terminology Service",
  "status": "active",
  "experimental": false,
  "date": "2025-08-01T16:38:28+00:00",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "name": "FHIR Project",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "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.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "RESTful Artifact Terminology Server",
      "security": {
        "cors": true,
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "Certificates"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "CodeSystem",
          "profile": "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem",
          "supportedProfile": [
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablecodesystem"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read allows clients to get the definitions and details of supported code systems"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search allows clients to search for supported code systems"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-title",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "description",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/CodeSystem-code",
              "type": "token"
            }
          ]
        },
        {
          "type": "ValueSet",
          "profile": "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablevalueset",
          "supportedProfile": [
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-computablevalueset",
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-expandedvalueset",
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablevalueset"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read allows clients to get the logical definitions of the value sets"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search allows clients to find value sets on the server"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-title",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "description",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-description",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-url",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-version",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-code",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "context",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-context",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "context-type",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "context-type-quantity",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-quantity",
              "type": "composite"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "context-type-value",
              "definition": "http://hl7.org/fhir/SearchParameter/conformance-context-type-value",
              "type": "composite"
            }
          ]
        },
        {
          "type": "Library",
          "profile": "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary",
          "supportedProfile": [
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablelibrary",
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-computablelibrary",
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-executablelibrary",
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary",
            "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-moduledefinitionlibrary"
          ],
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read allows clients to get the logical definitions of the available artifact libraries"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search allows clients to find artifact libraries on the server"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-date",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-title",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-identifier",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "description",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-description",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-status",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-url",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-version",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "composed-of",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-composed-of",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "depends-on",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-composed-of",
              "type": "reference"
            }
          ]
        }
      ],
      "operation": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "expand",
          "definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "name": "expand",
          "definition": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-valueset-expand"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "lookup",
          "definition": "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "validate-code",
          "definition": "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "name": "expand",
          "definition": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-valueset-validate-code"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "name": "package",
          "definition": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-package"
        }
      ]
    }
  ]
}

FHIR IG Statistics: CapabilityStatement/crmi-artifact-terminology-service

Resources that use this resource

Resources that this resource uses

Narrative

CRMI Artifact Terminology Service

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL CodeSystem

Resource Conformance: SHALL ValueSet

Resource Conformance: SHALL Library

Operations

Use

Source

Mode: `server`