FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/IHE.SVCM.TerminologyRepository

Packageihe.iti.svcm
TypeCapabilityStatement
IdIHE.SVCM.TerminologyRepository
FHIR VersionR4
Sourcehttps://profiles.ihe.net/ITI/SVCM/https://build.fhir.org/ig/IHE/ITI.SVCM/CapabilityStatement-IHE.SVCM.TerminologyRepository.html
URLhttps://profiles.ihe.net/ITI/SVCM/CapabilityStatement/IHE.SVCM.TerminologyRepository
Version1.5.2-current
Statusactive
Date2022-03-31
NameIHE_SVCM_TerminologyRepository
TitleIHE SVCM Terminology Repository
Realmuv
Authorityihe
DescriptionCapabilityStatement for Terminology Repository Actor in the IHE IT Infrastructure Technical Framework Supplement [SVCM](index.html).
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
IHE.SVCM.CodeSystemSVCM CodeSystem
IHE.SVCM.ConceptMapSVCM ConceptMap
IHE.SVCM.ValueSetSVCM ValueSet

Narrative

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

Generated Narrative: CapabilityStatement IHE.SVCM.TerminologyRepository

IHE SVCM Terminology Repository

  • 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: server

SVCM Terminology Repository will respond to queries for terminology resources.

Security

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

Summary of System-wide Interactions
  • Supports the search-systeminteraction.

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$expand, $validate-code
CodeSystemSupported Profiles
  SVCM CodeSystem
yy_id, _lastUpdate, status, identifier, name, description, system, title, url, version$lookup, $validate-code
ConceptMapSupported Profiles
  SVCM ConceptMap
yy_id, _lastUpdate, status, identifier, name, description, title, url, version, source-system, source-uri, target-system, target-uri$translate

Resource Conformance: supported ValueSet

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

Supported Profiles

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: supported CodeSystem

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

Supported Profiles

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: supported ConceptMap

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

Supported Profiles

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.


Source

{
  "resourceType": "CapabilityStatement",
  "id": "IHE.SVCM.TerminologyRepository",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://profiles.ihe.net/ITI/SVCM/CapabilityStatement/IHE.SVCM.TerminologyRepository",
  "version": "1.5.2-current",
  "name": "IHE_SVCM_TerminologyRepository",
  "title": "IHE SVCM Terminology Repository",
  "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 Repository 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": "server",
      "documentation": "SVCM Terminology Repository will respond to queries 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"
        }
      ]
    }
  ]
}