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

FHIR IG Statistics: CapabilityStatement/cql-evaluation-service-example

Packagehl7.fhir.uv.cql
Resource TypeCapabilityStatement
Idcql-evaluation-service-example
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/cql/https://build.fhir.org/ig/HL7/cql-ig/CapabilityStatement-cql-evaluation-service-example.html
URLhttp://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service-example
Version2.0.0
Statusdraft
Date2016-09-16
NameLibraryEvaluationServiceCapabilityStatementExample
TitleLibrary Evaluation Service Capability Statement Example
Realmuv
Authorityhl7
DescriptionBasic conformance statement for a Library Evaluation Service. A server can support more functionality than defined here, but this is the minimum amount
Kindinstance

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
cql-cqlCQL CQL
cql-library-evaluateCQL Library Evaluate

Narrative

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

Generated Narrative: CapabilityStatement cql-evaluation-service-example

Library Evaluation Service Capability Statement Example

  • Implementation Guide Version: 2.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Supported Patch Formats:
  • Published on: 2016-09-16
  • Published by: HL7 International / Clinical Decision Support

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.

This CapabilityStatement instantiates the CapabilityStatement http://hl7.org/fhir/knowledge-repository (Knowledge Repository Service Conformance Statement)

FHIR RESTful Capabilities

Mode: server

RESTful Library Evaluation Service

Security
Enable CORS: yes
Security services supported: Certificates
Summary of System-wide Interactions

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
Libraryhttp://hl7.org/fhir/StructureDefinition/Libraryyydescription, identifier, status, title, topic, version, url

Resource Conformance: supported Library

Base System Profile
Library
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read allows clients to get the logical definitions of the libraries

    search-type

    Search allows clients to find libraries on the server

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdescriptionstring
SHALLidentifiertoken
SHALLstatustoken
SHALLtitlestring
SHALLtopictoken
SHALLversiontoken
SHALLurluri
 

Operations

Use

Source

{
  "resourceType": "CapabilityStatement",
  "id": "cql-evaluation-service-example",
  "meta": {
    "profile": [
      "http://hl7.org/fhir/uv/cql/StructureDefinition/cql-capabilitystatement"
    ]
  },
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.org/fhir/uv/cql/CapabilityStatement/cql-evaluation-service-example",
  "version": "2.0.0",
  "name": "LibraryEvaluationServiceCapabilityStatementExample",
  "title": "Library Evaluation Service Capability Statement Example",
  "status": "draft",
  "date": "2016-09-16",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "Basic conformance statement for a Library Evaluation Service. A server can support more functionality    than defined here, but this is the minimum amount",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "kind": "instance",
  "instantiates": [
    "http://hl7.org/fhir/knowledge-repository"
  ],
  "software": {
    "name": "ACME Library Evaluation Service"
  },
  "implementation": {
    "description": "This service supports basic library repository features as well as library evaluation using the $evaluate operation.",
    "url": "https://example.org/fhir"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-supportedCqlVersion",
          "valueString": "1.5"
        },
        {
          "url": "http://hl7.org/fhir/StructureDefinition/cqf-supportedCqlVersion",
          "valueString": "1.4"
        }
      ],
      "mode": "server",
      "documentation": "RESTful Library Evaluation Service",
      "security": {
        "cors": true,
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "Certificates"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "Library",
          "profile": "http://hl7.org/fhir/StructureDefinition/Library",
          "interaction": [
            {
              "code": "read",
              "documentation": "Read allows clients to get the logical definitions of the libraries"
            },
            {
              "code": "search-type",
              "documentation": "Search allows clients to find libraries on the server"
            }
          ],
          "searchParam": [
            {
              "name": "description",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-description",
              "type": "string"
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-identifier",
              "type": "token"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-status",
              "type": "token"
            },
            {
              "name": "title",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-title",
              "type": "string"
            },
            {
              "name": "topic",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-topic",
              "type": "token"
            },
            {
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-version",
              "type": "token"
            },
            {
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/Library-url",
              "type": "uri"
            }
          ]
        }
      ],
      "operation": [
        {
          "name": "cql",
          "definition": "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-cql"
        },
        {
          "name": "evaluate",
          "definition": "http://hl7.org/fhir/uv/cql/OperationDefinition/cql-library-evaluate"
        }
      ]
    }
  ]
}