Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-24698

Need a normative terminology service capability statement

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • STU3
    • Terminology Infrastructure
    • TerminologyCapabilities
    • Terminology Service
    • Hide

      Update the text to match the following requirements for the minimum FHIR terminology server capabilities (as decided by the task force):

      • RESTful API requirements
        • FHIR Terminology Servers SHALL support
          • both the XML and JSON FHIR formats.
          • the READ and SEARCH interaction for CodeSystem, ValueSet and ConceptMap
          • the following elements as search parameters for CodeSystem, ValueSet and ConceptMap
            • url
            • version
            • status
            • name
            • title
          • the capabilities interaction with absent mode parameter or a mode parameter value of 'full' returning a CapabilityStatement resource which includes (at minimum) the following elements (plus the other requirements for a conformant CapabilityStatement resource instance):
            • url
            • version
            • name
            • title
            • status (note: mandatory element)
            • date
            • description
            • kind with a fixed value of 'instance'
            • fhirVersion
          • the capabilities interaction with a mode parameter value of 'terminology' returning a TerminologyCapabilities resource which includes the following elements (plus the other requirements for a conformant TerminologyCapabilities resource instance):
            • url
            • name
            • title
            • status (note: mandatory element)
            • date
            • codeSystem (for each coding system supported for terminology services)
            • kind with a fixed value of 'instance'
            • codeSystem.uri (for each coding system supported for terminology services)
            • codeSystem.version (for  each coding system supported for terminology services which has a version)
            • codeSystem.version.code (for  each version of coding systems supported for terminology services) 
      • Terminology Service Operations
        • FHIR Terminology Servers SHALL support the following operations with the associated level and required input parameters:
      Operation Level
       
      Required input parameters
      System Type Instance
      ValueSet-expand N/A Y Y
      • url
      • filter
      • offset
      • count
      ValueSet-validate-code N/A Y Y
      • url
      • code
      • system
      • systemVersion
      • display
      ConceptMap-translate N/A Y Y
      • url
      • sourceCode
      • system
      • targetCode
      • targetSystem
      CodeSystem-lookup N/A Y N
      • code
      • system
      • version
      CodeSystem-validate-code N/A Y N
      • code
      • system
      • version
      • display
      CodeSystem-subsumes N/A Y N
      • codeA
      • codeB
      • system
      • version

       
      Update the existing CapabilityStatement to reflect the new requirements.
      Add a TerminologyCapabilities example that reflects the new requirements.
       
       

      Show
      Update the text to match the following requirements for the minimum FHIR terminology server capabilities (as decided by the task force): RESTful API requirements FHIR Terminology Servers SHALL support both the XML and JSON FHIR formats. the READ and SEARCH interaction for CodeSystem, ValueSet and ConceptMap the following elements as search parameters for CodeSystem, ValueSet and ConceptMap url version status name title the  capabilities interaction with absent mode parameter or a mode parameter value of 'full' returning a CapabilityStatement resource which includes (at minimum) the following elements (plus the other requirements for a conformant CapabilityStatement resource instance): url version name title status (note: mandatory element) date description kind with a fixed value of 'instance' fhirVersion the  capabilities interaction with a mode parameter value of 'terminology' returning a TerminologyCapabilities resource which includes the following elements (plus the other requirements for a conformant TerminologyCapabilities resource instance): url name title status (note: mandatory element) date codeSystem (for each coding system supported for terminology services) kind with a fixed value of 'instance' codeSystem.uri (for each coding system supported for terminology services) codeSystem.version (for  each coding system supported for terminology services which has a version) codeSystem.version.code (for  each version of coding systems supported for terminology services)  Terminology Service Operations FHIR Terminology Servers SHALL support the following operations with the associated level and required input parameters: Operation Level   Required input parameters System Type Instance ValueSet-expand N/A Y Y url filter offset count ValueSet-validate-code N/A Y Y url code system systemVersion display ConceptMap-translate N/A Y Y url sourceCode system targetCode targetSystem CodeSystem-lookup N/A Y N code system version CodeSystem-validate-code N/A Y N code system version display CodeSystem-subsumes N/A Y N codeA codeB system version   Update the existing CapabilityStatement to reflect the new requirements. Add a TerminologyCapabilities example that reflects the new requirements.    
    • Reuben Daniels / Carmela Couderc : 11-0-1
    • Enhancement
    • Non-compatible
    • R5

    Description

      We need to have a normative terminology service capability statement that defines the minimum requirements for a terminology service. Currently the terminology service page http://build.fhir.org/terminology-service.html links to this example cabability statement here:

      http://build.fhir.org/capabilitystatement-terminology-server.html

      Instead we need to create and link to a normative statment that is updated to reflect the present understanding of the minimum requirements.

      Attachments

        Activity

          People

            reuben.daniels Reuben Daniels
            rhausam Robert Hausam
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: