Sharing Valuesets, Codes, and Maps (SVCM)
1.5.2-current - ci-build
Sharing Valuesets, Codes, and Maps (SVCM)
1.5.2-current - ci-build
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
| Active as of 2022-03-31 |
{
"resourceType" : "CapabilityStatement",
"id" : "IHE.SVCM.TerminologyConsumer",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2 id=\"title\">IHE SVCM Terminology Consumer</h2><ul><li>Implementation Guide Version: 1.5.2-current</li><li>FHIR Version: 4.0.1</li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-03-31</li><li>Published by: IHE IT Infrastructure Technical Committee</li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>SVCM Terminology Consumer will query for terminology resources.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Recommend <a href=\"https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html\">ATNA</a>, encouraged <a href=\"https://profiles.ihe.net/ITI/IUA/index.html\">IHE-IUA</a> or SMART-on-FHIR</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>search-system</code> interaction.</li></ul></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#ValueSet1-1\">ValueSet</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-IHE.SVCM.ValueSet.html\">SVCM ValueSet</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdate, status, identifier, name, description, reference, title, url, version</td><td/><td/><td/></tr><tr><td><a href=\"#CodeSystem1-2\">CodeSystem</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-IHE.SVCM.CodeSystem.html\">SVCM CodeSystem</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdate, status, identifier, name, description, system, title, url, version</td><td/><td/><td/></tr><tr><td><a href=\"#ConceptMap1-3\">ConceptMap</a></td><td>Supported profiles:<br/>\u00a0\u00a0<a href=\"StructureDefinition-IHE.SVCM.ConceptMap.html\">SVCM ConceptMap</a></td><td>y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdate, status, identifier, name, description, title, url, version, source-system, source-uri, target-system, target-uri</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ValueSet1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported</span>ValueSet</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/valueset.html\">ValueSet</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-IHE.SVCM.ValueSet.html\">https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.ValueSet</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For Query Value Set [ITI-95], Expand Value Set [ITI-97], Validate Code [ITI-99]</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdate</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>description</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>reference</td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>title</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>version</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$$expand</td><td><div><p><code>url</code> is a required parameter for this operation.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>$$validate-code</td><td><div><p><code>url</code>, <code>code</code>, and <code>system</code> are required parameters for this operation.</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"CodeSystem1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported</span>CodeSystem</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/codesystem.html\">CodeSystem</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-IHE.SVCM.CodeSystem.html\">https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.CodeSystem</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For Query Code System [ITI-96], Lookup Code [ITI-98], Validate Code [ITI-99]</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdate</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>description</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>system</td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>title</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>version</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$$lookup</td><td><div><p><code>code</code> and <code>system</code> are required parameters for this operation.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>$$validate-code</td><td><div><p><code>url</code> and <code>code</code> are required parameters for this operation.</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ConceptMap1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported</span>ConceptMap</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/conceptmap.html\">ConceptMap</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-IHE.SVCM.ConceptMap.html\">https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.ConceptMap</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For Query Concept Map [ITI-100] and Translate Code [ITI-101]</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdate</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>description</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>title</td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>version</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>source-system</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>source-uri</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>target-system</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>target-uri</td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$$translate</td><td><div><p><code>url</code>, <code>source</code>, <code>code</code>, <code>system</code>, and <code>target</code> are required parameters for this operation.</p>\n</div></td></tr></tbody></table></div></div></div></div></div></div>"
},
"url" : "https://profiles.ihe.net/ITI/SVCM/CapabilityStatement/IHE.SVCM.TerminologyConsumer",
"version" : "1.5.2-current",
"name" : "IHE_SVCM_TerminologyConsumer",
"title" : "IHE SVCM Terminology Consumer",
"status" : "active",
"experimental" : false,
"date" : "2022-03-31",
"publisher" : "IHE IT Infrastructure Technical Committee",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "https://www.ihe.net/ihe_domains/it_infrastructure/"
}
]
},
{
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
},
{
"name" : "IHE IT Infrastructure Technical Committee",
"telecom" : [
{
"system" : "email",
"value" : "iti@ihe.net"
}
]
}
],
"description" : "CapabilityStatement for Terminology Consumer Actor in the IHE IT Infrastructure Technical Framework Supplement [SVCM](index.html).",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "SVCM Terminology Consumer will query for terminology resources.",
"security" : {
"description" : "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or SMART-on-FHIR"
},
"resource" : [
{
"type" : "ValueSet",
"supportedProfile" : [
🔗 "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]",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "token"
},
{
"name" : "_lastUpdate",
"type" : "date"
},
{
"name" : "status",
"type" : "token"
},
{
"name" : "identifier",
"type" : "token"
},
{
"name" : "name",
"type" : "string"
},
{
"name" : "description",
"type" : "string"
},
{
"name" : "reference",
"type" : "uri"
},
{
"name" : "title",
"type" : "string"
},
{
"name" : "url",
"type" : "uri"
},
{
"name" : "version",
"type" : "token"
}
],
"operation" : [
{
"name" : "$expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand",
"documentation" : "`url` is a required parameter for this operation."
},
{
"name" : "$validate-code",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code",
"documentation" : "`url`, `code`, and `system` are required parameters for this operation."
}
]
},
{
"type" : "CodeSystem",
"supportedProfile" : [
🔗 "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]",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "token"
},
{
"name" : "_lastUpdate",
"type" : "date"
},
{
"name" : "status",
"type" : "token"
},
{
"name" : "identifier",
"type" : "token"
},
{
"name" : "name",
"type" : "string"
},
{
"name" : "description",
"type" : "string"
},
{
"name" : "system",
"type" : "uri"
},
{
"name" : "title",
"type" : "string"
},
{
"name" : "url",
"type" : "uri"
},
{
"name" : "version",
"type" : "token"
}
],
"operation" : [
{
"name" : "$lookup",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup",
"documentation" : "`code` and `system` are required parameters for this operation."
},
{
"name" : "$validate-code",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code",
"documentation" : "`url` and `code` are required parameters for this operation."
}
]
},
{
"type" : "ConceptMap",
"supportedProfile" : [
🔗 "https://profiles.ihe.net/ITI/SVCM/StructureDefinition/IHE.SVCM.ConceptMap"
],
"documentation" : "For Query Concept Map [ITI-100] and Translate Code [ITI-101]",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"name" : "_id",
"type" : "token"
},
{
"name" : "_lastUpdate",
"type" : "date"
},
{
"name" : "status",
"type" : "token"
},
{
"name" : "identifier",
"type" : "token"
},
{
"name" : "name",
"type" : "string"
},
{
"name" : "description",
"type" : "string"
},
{
"name" : "title",
"type" : "string"
},
{
"name" : "url",
"type" : "uri"
},
{
"name" : "version",
"type" : "token"
},
{
"name" : "source-system",
"type" : "token"
},
{
"name" : "source-uri",
"type" : "reference"
},
{
"name" : "target-system",
"type" : "token"
},
{
"name" : "target-uri",
"type" : "reference"
}
],
"operation" : [
{
"name" : "$translate",
"definition" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate",
"documentation" : "`url`, `source`, `code`, `system`, and `target` are required parameters for this operation."
}
]
}
],
"interaction" : [
{
"code" : "search-system"
}
]
}
]
}
IG © 2023+ IHE IT Infrastructure Technical Committee. Package ihe.iti.svcm#1.5.2-current based on FHIR 4.0.1. Generated 2024-05-06
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change