Generated Narrative: CapabilityStatement example-terminology-server

ACME Terminology Service — Capability Statement

  • Implementation Guide Version: 6.0.0-ballot4
  • FHIR Version: 6.0.0-ballot4
  • Supported Formats: json, xml
  • Published on: 2022-09-01
  • Published by: HL7 International / FHIR Infrastructure

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

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 ( R ead, S earch, U pdate, and C reate, are always shown, while VR ead, P atch, D elete, H istory on I nstance, or H istory on T ype 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 Type Profile R S U C Searches _include _revinclude Operations
CodeSystem http://hl7.org/fhir/StructureDefinition/CodeSystem Y Y url, version, name, title, status $expand, $expand, $expand
ValueSet http://hl7.org/fhir/StructureDefinition/ValueSet Y Y url, version, name, title, status $expand, $expand
ConceptMap http://hl7.org/fhir/StructureDefinition/ConceptMap Y Y url, version, name, title, status $expand

Resource Conformance: SHALL CodeSystem

Base System Profile
CodeSystem
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
Conformance Parameter Type Documentation
SHALL url uri
SHALL version token
SHALL name string
SHALL title string
SHALL status token
 
Extended Operations
Conformance Operation Documentation
SHALL $expand
SHALL $expand
SHALL $expand

Resource Conformance: SHALL ValueSet

Base System Profile
ValueSet
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
Conformance Parameter Type Documentation
SHALL url uri
SHALL version token
SHALL name string
SHALL title string
SHALL status token
 
Extended Operations
Conformance Operation Documentation
SHALL $expand
SHALL $expand

Resource Conformance: SHALL ConceptMap

Base System Profile
ConceptMap
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Search Parameters
Conformance Parameter Type Documentation
SHALL url uri
SHALL version token
SHALL name string
SHALL title string
SHALL status token
 
Extended Operations
Conformance Operation Documentation
SHALL $expand
<status value="draft"/><date value="2022-09-01"/><publisher value="HL7 International / FHIR Infrastructure"/><contact><telecom><system value="url"/><value value="http://www.hl7.org/Special/committees/fiwg"/></telecom></contact><description value="Example capability statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount"/><kind value="instance"/><implementation><description value="The ACME FHIR Terminology Server"/></implementation><fhirVersion value="6.0.0-ballot4"/><format value="json"/><format value="xml"/><rest><mode value="server"/><resource><type value="CodeSystem"/><profile value="http://hl7.org/fhir/StructureDefinition/CodeSystem"/><interaction><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><code value="read"/></interaction><interaction><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><code value="search-type"/></interaction><searchParam><name value="url"/><definition value="http://hl7.org/fhir/SearchParameter/CodeSystem-url"/><type value="uri"/></searchParam><searchParam><name value="version"/><definition value="http://hl7.org/fhir/SearchParameter/CodeSystem-version"/><type value="token"/></searchParam><searchParam><name value="name"/><definition value="http://hl7.org/fhir/SearchParameter/CodeSystem-name"/><type value="string"/></searchParam><searchParam><name value="title"/><definition value="http://hl7.org/fhir/SearchParameter/CodeSystem-title"/><type value="string"/></searchParam><searchParam><name value="status"/><definition value="http://hl7.org/fhir/SearchParameter/CodeSystem-status"/><type value="token"/></searchParam><operation><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><name value="expand"/><definition value="http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup"/></operation><operation><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><name value="expand"/><definition value="http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code"/></operation><operation><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><name value="expand"/><definition value="http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes"/></operation></resource><resource><type value="ValueSet"/><profile value="http://hl7.org/fhir/StructureDefinition/ValueSet"/><interaction><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><code value="read"/></interaction><interaction><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><code value="search-type"/></interaction><searchParam><name value="url"/><definition value="http://hl7.org/fhir/SearchParameter/ValueSet-url"/><type value="uri"/></searchParam><searchParam><name value="version"/><definition value="http://hl7.org/fhir/SearchParameter/ValueSet-version"/><type value="token"/></searchParam><searchParam><name value="name"/><definition value="http://hl7.org/fhir/SearchParameter/ValueSet-name"/><type value="string"/></searchParam><searchParam><name value="title"/><definition value="http://hl7.org/fhir/SearchParameter/ValueSet-title"/><type value="string"/></searchParam><searchParam><name value="status"/><definition value="http://hl7.org/fhir/SearchParameter/ValueSet-status"/><type value="token"/></searchParam><operation><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><name value="expand"/><definition value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/></operation><operation><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><name value="expand"/><definition value="http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"/></operation></resource><resource><type value="ConceptMap"/><profile value="http://hl7.org/fhir/StructureDefinition/ConceptMap"/><interaction><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><code value="read"/></interaction><interaction><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><code value="search-type"/></interaction><searchParam><name value="url"/><definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-url"/><type value="uri"/></searchParam><searchParam><name value="version"/><definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-version"/><type value="token"/></searchParam><searchParam><name value="name"/><definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-name"/><type value="string"/></searchParam><searchParam><name value="title"/><definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-title"/><type value="string"/></searchParam><searchParam><name value="status"/><definition value="http://hl7.org/fhir/SearchParameter/ConceptMap-status"/><type value="token"/></searchParam><operation><extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"><valueCode value="SHALL"/></extension><name value="expand"/><definition value="http://hl7.org/fhir/OperationDefinition/ConceptMap-translate"/></operation></resource></rest></CapabilityStatement>