Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1 International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, 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: 1.0.0
Active as of 2024-05-31 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

CRMI Artifact Terminology Service

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Supported Patch Formats:
  • Published on: 2024-05-31 16:42:56+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

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 TypeProfileRSUCSearches_include_revincludeOperations
CodeSystemhttp://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem
Additional supported profiles:
  CRMI Publishable CodeSystem		yyurl, version, identifier, name, title, description, status, code
ValueSethttp://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablevalueset
Additional supported profiles:
  CRMI Computable ValueSet
  CRMI Expanded ValueSet
  CRMI Publishable ValueSet		yydate, name, title, identifier, description, status, url, version, code, context, context-type, context-type-quantity, context-type-value
Libraryhttp://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		yydate, name, title, identifier, description, status, url, version, composed-of, depends-on

Resource Conformance: SHALL CodeSystem

Base System Profile
http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablecodesystem
Profile Conformance
SHALL
Reference Policy

Supported Profiles

http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablecodesystem

Interaction summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLurluri
SHALLversiontoken
SHALLidentifiertoken
SHALLnamestring
SHALLtitlestring
SHALLdescriptionstring
SHALLcodetoken
SHOULDstatustoken
 

Resource Conformance: SHALL ValueSet

Base System Profile
http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablevalueset
Profile Conformance
SHALL
Reference Policy

Supported Profiles

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 summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate
SHALLnamestring
SHALLtitlestring
SHALLidentifiertoken
SHALLdescriptionstring
SHALLstatustoken
SHALLurluri
SHALLversiontoken
SHALLcodetoken
SHOULDcontexttoken
SHOULDcontext-typetoken
SHOULDcontext-type-quantitycomposite
SHOULDcontext-type-valuecomposite
 

Resource Conformance: SHALL Library

Base System Profile
http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareablelibrary
Profile Conformance
SHALL
Reference Policy

Supported Profiles

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 summary
  • SHALLsupport read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatedate
SHALLnamestring
SHALLtitlestring
SHALLidentifiertoken
SHALLdescriptionstring
SHALLstatustoken
SHALLurluri
SHALLversiontoken
SHALLcomposed-ofreference
SHALLdepends-onreference