Release 5 R6 Ballot (3rd Draft)
This page is part of the FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Publish-box (todo)

Example CapabilityStatement/example-terminology-server (Narrative)

FHIR Infrastructure Work Group Maturity Level : N/A Standards Status : Informative Compartments : No defined compartments

This is the narrative for the resource. See also the XML , JSON or Turtle format. This example conforms to the profile CapabilityStatement .

ACMETerminologyServiceCapabilityStatement

Generated Narrative: CapabilityStatement example-terminology-server

ACME Terminology Service — Capability Statement

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

Example Note to Implementers: FHIR Capabilities

Any FHIR capability statement for a Terminology Server. 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 can support more fucntionality than defined here, but

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this is 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 minimum amount 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
Mode SHALL SERVER url uri
Description SHALL version token
Transaction SHALL name string
System History SHALL title string
System Search SHALL status token
 
Extended Operations
Conformance Operation Documentation
Resource Type 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 Read Search Update
Conformance Parameter Type Documentation
SHALL url uri
SHALL version token
SHALL name string
SHALL title string
SHALL status token
 
Extended Operations Create
Conformance Operation Documentation
SHALL $expand
CodeSystem SHALL http://hl7.org/fhir/StructureDefinition/CodeSystem $expand y

Resource Conformance: SHALL ConceptMap

Base System Profile
ConceptMap
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read , search-type .

Search Parameters http://hl7.org/fhir/StructureDefinition/ValueSet http://hl7.org/fhir/StructureDefinition/ConceptMap
Conformance Parameter Type Documentation
SHALL y url uri
ValueSet SHALL version token y
y SHALL name string
ConceptMap SHALL title string y
y SHALL status token
 
Extended Operations
Conformance Operation Documentation
SHALL $expand

 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.