R5 Final QA

This page is part of the FHIR Specification (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CapabilityStatement/knowledge-repository (XML)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

Raw XML (canonical form + also see XML Format Specification)

Jump past Narrative

Knowledge Repository Base Capability Statement (id = "knowledge-repository")

<?xml version="1.0" encoding="UTF-8"?>

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="knowledge-repository"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      
      <h2> Knowledge Repository Service Conformance Statement</h2> 
      
      <div> 
        
        <p> Basic conformance statement for a Knowledge Repository Service. A server can support
           more functionality
           than defined here, but this is the minimum amount</p> 

      
      </div> 
      
      <table> 
        
        <tr> 
          
          <td> Mode</td> 
          
          <td> SERVER</td> 
        
        </tr> 
        
        <tr> 
          
          <td> Description</td> 
          
          <td> RESTful Knowledge Repository Server</td> 
        
        </tr> 
        
        <tr> 
          
          <td> Transaction</td> 
          
          <td/>  
        
        </tr> 
        
        <tr> 
          
          <td> System History</td> 
          
          <td/>  
        
        </tr> 
        
        <tr> 
          
          <td> System Search</td> 
          
          <td/>  
        
        </tr> 
      
      </table> 
      
      <table> 
        
        <tr> 
          
          <th> 
            
            <b> Resource Type</b> 
          
          </th> 
          
          <th> 
            
            <b> Profile</b> 
          
          </th> 
          
          <th> 
            
            <b> Read</b> 
          
          </th> 
          
          <th> 
            
            <b> V-Read</b> 
          
          </th> 
          
          <th> 
            
            <b> Search</b> 
          
          </th> 
          
          <th> 
            
            <b> Update</b> 
          
          </th> 
          
          <th> 
            
            <b> Updates</b> 
          
          </th> 
          
          <th> 
            
            <b> Create</b> 
          
          </th> 
          
          <th> 
            
            <b> Delete</b> 
          
          </th> 
          
          <th> 
            
            <b> History</b> 
          
          </th> 
        
        </tr> 
      
      </table> 
    
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/knowledge-repository"/> 
  <name value="KnowledgeRepositoryServiceConformanceStatement"/> 
  <title value="Knowledge Repository Service Conformance Statement"/> 
  <status value="draft"/> 
  <date value="2017-02-25"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <name value="FHIR Project"/> 
    <telecom> 
      <system value="other"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="Basic conformance statement for a Knowledge Repository Service. A server can support
   more functionality    than defined here, but this is the minimum amount"/> 
  <kind value="capability"/> 
  <software> 
    <name value="ACME Knowledge Repository Service"/> 
  </software> 
  <fhirVersion value="5.0.0"/> 
  <format value="json"/> 
  <format value="xml"/> 
  <rest> 
    <mode value="server"/> 
    <documentation value="RESTful Knowledge Repository Service"/> 
    <security> 
      <cors value="true"/> 
      <service> 
        <coding> 
          <system value="http://hl7.org/fhir/restful-security-service"/> 
          <code value="Certificates"/> 
        </coding> 
      </service> 
    </security> 
    <resource> 
      <type value="Library"/> 
      <profile value="http://hl7.org/fhir/StructureDefinition/Library"/> 
      <interaction> 
        <code value="read"/> 
        <documentation value="Read allows clients to get the logical definitions of the libraries"/> 
      </interaction> 
      <interaction> 
        <code value="search-type"/> 
        <documentation value="Search allows clients to filter libraries based on a provided search parameter"/> 
      </interaction> 
      <searchParam> 
        <name value="description"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-description"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="identifier"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-identifier"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="status"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-status"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="title"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-title"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="topic"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-topic"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="version"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-version"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="composed-of"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-composed-of"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="depends-on"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-depends-on"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="derived-from"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-derived-from"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="predecessor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-predecessor"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="successor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Library-successor"/> 
        <type value="reference"/> 
      </searchParam> 
    </resource> 
    <resource> 
      <type value="PlanDefinition"/> 
      <profile value="http://hl7.org/fhir/StructureDefinition/PlanDefinition"/> 
      <interaction> 
        <code value="read"/> 
        <documentation value="Read allows clients to get the logical definitions of the plan definitions"/> 
      </interaction> 
      <interaction> 
        <code value="search-type"/> 
        <documentation value="Search allows clients to filter plan definitions based on a provided search parameter"/> 
      </interaction> 
      <searchParam> 
        <name value="description"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-description"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="identifier"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="status"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-status"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="title"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-title"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="topic"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-topic"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="version"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-version"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="composed-of"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-composed-of"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="depends-on"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-depends-on"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="derived-from"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-derived-from"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="predecessor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-predecessor"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="successor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/PlanDefinition-successor"/> 
        <type value="reference"/> 
      </searchParam> 
    </resource> 
    <resource> 
      <type value="ActivityDefinition"/> 
      <profile value="http://hl7.org/fhir/StructureDefinition/ActivityDefinition"/> 
      <interaction> 
        <code value="read"/> 
        <documentation value="Read allows clients to get the logical definitions of the activity definitions"/> 
      </interaction> 
      <interaction> 
        <code value="search-type"/> 
        <documentation value="Search allows clients to filter activity definitions based on a provided search
         parameter"/> 
      </interaction> 
      <searchParam> 
        <name value="description"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-description"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="identifier"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="status"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-status"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="title"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-title"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="topic"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-topic"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="version"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-version"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="composed-of"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-composed-of"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="depends-on"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-depends-on"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="derived-from"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-derived-from"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="predecessor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-predecessor"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="successor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/ActivityDefinition-successor"/> 
        <type value="reference"/> 
      </searchParam> 
    </resource> 
    <resource> 
      <type value="Measure"/> 
      <profile value="http://hl7.org/fhir/StructureDefinition/Measure"/> 
      <interaction> 
        <code value="read"/> 
        <documentation value="Read allows clients to get the logical definitions of the measures"/> 
      </interaction> 
      <interaction> 
        <code value="search-type"/> 
        <documentation value="Search allows clients to filter measures based on a provided search parameter"/> 
      </interaction> 
      <searchParam> 
        <name value="description"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-description"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="identifier"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-identifier"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="status"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-status"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="title"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-title"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="topic"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-topic"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="version"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-version"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="composed-of"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-composed-of"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="depends-on"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-depends-on"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="derived-from"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-derived-from"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="predecessor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-predecessor"/> 
        <type value="reference"/> 
      </searchParam> 
      <searchParam> 
        <name value="successor"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Measure-successor"/> 
        <type value="reference"/> 
      </searchParam> 
    </resource> 
    <resource> 
      <type value="Questionnaire"/> 
      <profile value="http://hl7.org/fhir/StructureDefinition/Questionnaire"/> 
      <interaction> 
        <code value="read"/> 
        <documentation value="Read allows clients to get the logical definitions of the measures"/> 
      </interaction> 
      <interaction> 
        <code value="search-type"/> 
        <documentation value="Search allows clients to filter measures based on a provided search parameter"/> 
      </interaction> 
      <searchParam> 
        <name value="code"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-code"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="context"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-context"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="date"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-date"/> 
        <type value="date"/> 
      </searchParam> 
      <searchParam> 
        <name value="identifier"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-identifier"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="publisher"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-publisher"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="status"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-status"/> 
        <type value="token"/> 
      </searchParam> 
      <searchParam> 
        <name value="title"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-title"/> 
        <type value="string"/> 
      </searchParam> 
      <searchParam> 
        <name value="version"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Questionnaire-version"/> 
        <type value="token"/> 
      </searchParam> 
    </resource> 
    <operation> 
      <name value="data-requirements"/> 
      <definition value="http://hl7.org/fhir/OperationDefinition/Library-data-requirements"/> 
    </operation> 
  </rest> 
</CapabilityStatement>

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.