Sharing Valuesets, Codes, and Maps (SVCM)
1.5.2-current - ci-build International flag

Sharing Valuesets, Codes, and Maps (SVCM), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 1.5.2-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.SVCM/ and changes regularly. See the Directory of published versions

CapabilityStatement: IHE SVCM Terminology Consumer

Official URL: https://profiles.ihe.net/ITI/SVCM/CapabilityStatement/IHE.SVCM.TerminologyConsumer Version: 1.5.2-current
Active as of 2022-03-31 Computable Name: IHE_SVCM_TerminologyConsumer

CapabilityStatement for Terminology Consumer Actor in the IHE IT Infrastructure Technical Framework Supplement SVCM.

Raw OpenAPI-Swagger Definition file | Download

IHE SVCM Terminology Consumer

  • Implementation Guide Version: 1.5.2-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2022-03-31
  • Published by: IHE IT Infrastructure Technical Committee

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.

FHIR RESTful Capabilities

Mode: client

SVCM Terminology Consumer will query for terminology resources.

Security

Recommend ATNA, encouraged IHE-IUA or SMART-on-FHIR

Summary of System-wide Interactions
  • Supports the search-system interaction.

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
ValueSetSupported profiles:
  SVCM ValueSet		yy_id, _lastUpdate, status, identifier, name, description, reference, title, url, version
CodeSystemSupported profiles:
  SVCM CodeSystem		yy_id, _lastUpdate, status, identifier, name, description, system, title, url, version
ConceptMapSupported profiles:
  SVCM ConceptMap		yy_id, _lastUpdate, status, identifier, name, description, title, url, version, source-system, source-uri, target-system, target-uri

Resource Conformance: supportedValueSet

Core FHIR Resource
ValueSet
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.ValueSet

Documentation

For Query Value Set [ITI-95], Expand Value Set [ITI-97], Validate Code [ITI-99]

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdatedate
SHALLstatustoken
SHALLidentifiertoken
SHALLnamestring
SHALLdescriptionstring
SHALLreferenceuri
SHALLtitlestring
SHALLurluri
SHALLversiontoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$$expand

url is a required parameter for this operation.

SHALL$$validate-code

url, code, and system are required parameters for this operation.

Resource Conformance: supportedCodeSystem

Core FHIR Resource
CodeSystem
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.CodeSystem

Documentation

For Query Code System [ITI-96], Lookup Code [ITI-98], Validate Code [ITI-99]

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdatedate
SHALLstatustoken
SHALLidentifiertoken
SHALLnamestring
SHALLdescriptionstring
SHALLsystemuri
SHALLtitlestring
SHALLurluri
SHALLversiontoken
 
Extended Operations
ConformanceOperationDocumentation
SHALL$$lookup

code and system are required parameters for this operation.

SHALL$$validate-code

url and code are required parameters for this operation.

Resource Conformance: supportedConceptMap

Core FHIR Resource
ConceptMap
Reference Policy
Interaction summary
  • Supports search-type, read.

Supported Profiles

https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.ConceptMap

Documentation

For Query Concept Map [ITI-100] and Translate Code [ITI-101]

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdatedate
SHALLstatustoken
SHALLidentifiertoken
SHALLnamestring
SHALLdescriptionstring
SHALLtitlestring
SHALLurluri
SHALLversiontoken
SHALLsource-systemtoken
SHALLsource-urireference
SHALLtarget-systemtoken
SHALLtarget-urireference
 
Extended Operations
ConformanceOperationDocumentation
SHALL$$translate

url, source, code, system, and target are required parameters for this operation.