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

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

IHE SVCM Terminology Consumer

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

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

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Audit Event for Expand Value Set Transaction by the Terminology Consumer and Repository

Defines constraints on the AuditEvent Resource to record when an Expand Value Set Transaction happens to expand a ValueSet, as recorded by the Terminology Consumer and Registry.
Audit Event for Lookup Code Transaction by the Terminology Consumer and Repository

Defines constraints on the AuditEvent Resource to record when a Lookup Code Transaction happens to expand a CodeSystem, as recorded by the Terminology Consumer and Registry.
Audit Event for Query Code System Transaction by the Terminology Consumer and Repository for Query

Defines constraints on the AuditEvent Resource to record when a Query Code System Transaction happens to query a CodeSystem, as recorded by the Terminology Consumer and Registry.
Audit Event for Query Code System Transaction by the Terminology Consumer and Repository for Read

Defines constraints on the AuditEvent Resource to record when a Query Code System Transaction happens to read a CodeSystem, as recorded by the Terminology Consumer and Registry.
Audit Event for Query Concept Map Transaction by the Terminology Consumer and Repository for Query

Defines constraints on the AuditEvent Resource to record when a Query Concept Map Transaction happens to query a ConceptMap, as recorded by the Terminology Consumer and Registry.
Audit Event for Query Concept Map Transaction by the Terminology Consumer and Repository for Read

Defines constraints on the AuditEvent Resource to record when a Query Concept Map Transaction happens to read a ConceptMap, as recorded by the Terminology Consumer and Registry.
Audit Event for Query Value Set Transaction by the Terminology Consumer and Repository for Query

Defines constraints on the AuditEvent Resource to record when a Query Value Set Transaction happens to query a ValueSet, as recorded by the Terminology Consumer and Registry.
Audit Event for Query Value Set Transaction by the Terminology Consumer and Repository for Read

Defines constraints on the AuditEvent Resource to record when a Query Value Set Transaction happens to read a ValueSet, as recorded by the Terminology Consumer and Registry.
Audit Event for Translate Code Transaction by the Terminology Consumer and Repository

Defines constraints on the AuditEvent Resource to record when a Translate Code Transaction happens to translate a code using a ConceptMap, as recorded by the Terminology Consumer and Registry.
Audit Event for Validate Code Transaction by the Terminology Consumer and Repository

Defines constraints on the AuditEvent Resource to record when a Validate Code Transaction happens to validate a code, as recorded by the Terminology Consumer and Registry.
Basic AuditEvent for a successful Operation

A basic AuditEvent profile for when a RESTful Operation action happens successfully.

  • Given a RESTful Operation is requested
  • And the request is authorized
  • When successful
    • Note a failure AuditEvent may follow this pattern, but would not be a successful outcome and should have an OperationOutcome
    • Note success may result in zero or more results. The number of results and the content of the results are not recorded.
  • Then the AuditEvent recorded will conform
    • The raw operation parameters is placed in the .contained element. The contained parameters enables preserving exactly what was requested, including possibly malicious patterns. This enables detection of malicious or malformed requests.

Note: the pattern defined in DICOM and IHE have the client is identified as the Source Role ID, and the server is identified as the Destination Role ID. This represents the query parameters are flowing from the client to the server. This may not be so obvious, as the data actually flows the opposite direction. This pattern is established and thus followed here.
SVCM CodeSystem

A profile on the CodeSystem resource for SVCM.
SVCM ConceptMap

A profile on the ConceptMap resource for SVCM.
SVCM ValueSet

A profile on the ValueSet resource for SVCM.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Audit example for ITI-100 for Terminology Consumer for query.

Audit example for a Terminology Consumer requesting a query on a ConceptMap for ITI-100.
Audit example for ITI-100 for Terminology Consumer for read.

Audit example for a Terminology Consumer requesting a read on a ConceptMap for ITI-100.
Audit example for ITI-101 for Terminology Consumer for translate code.

Audit example for a Terminology Consumer requesting translate code for ITI-101.
Audit example for ITI-95 for Terminology Consumer for query.

Audit example for a Terminology Consumer requesting a query on a ValueSet for ITI-95.
Audit example for ITI-95 for Terminology Consumer for read.

Audit example for a Terminology Consumer requesting a read on a ValueSet for ITI-95.
Audit example for ITI-96 for Terminology Consumer for query.

Audit example for a Terminology Consumer requesting a query on a CodeSystem for ITI-96.
Audit example for ITI-96 for Terminology Consumer for read.

Audit example for a Terminology Consumer requesting a read on a CodeSystem for ITI-96.
Audit example for ITI-97 for Terminology Consumer for expand.

Audit example for a Terminology Consumer requesting Expand ValueSet for ITI-97.
Audit example for ITI-98 for Terminology Consumer for lookup code.

Audit example for a Terminology Consumer requesting lookup code for ITI-98.
Audit example for ITI-99 for Terminology Consumer for validate code on a CodeSystem.

Audit example for a Terminology Consumer requesting validate code on a CodeSystem for ITI-99.
Audit example for ITI-99 for Terminology Consumer for validate code on a ValueSet.

Audit example for a Terminology Consumer requesting validate code on a ValueSet for ITI-99.
Device Example for SVCM

Device Example for SVCM.
SVCM Example 2 CodeSystem

An example CodeSystem for SVCM for mapping
SVCM Example 2 ValueSet

An example 2 ValueSet for SVCM
SVCM Example CodeSystem

An example CodeSystem for SVCM
SVCM Example ConceptMap

An example ConceptMap for SVCM
SVCM Example ValueSet

An example ValueSet for SVCM