Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Example CapabilityStatement/example (XML)

FHIR Infrastructure Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: No defined compartments

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

Jump past Narrative

General Capability Example (id = "example")

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

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="example"/> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      
      <p> The EHR Server supports the following transactions for the resource Person: read,
         vread, 
        update, history, search(name,gender), create and updates.</p> 
      
      <p> The EHR System supports the following message: admin-notify::Person.</p> 
      
      <p> The EHR Application has a 
        
        <a href="http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4
        ea1-911a-721a60663796">general document profile</a> .
      
      </p> 
    
    </div> 
  </text> 
  <url value="urn:uuid:68d043b5-9ecf-4559-a57a-396e0d452311"/> 
  <version value="20130510"/> 
  <name value="ACMEEHR"/> 
  <title value="ACME EHR capability statement"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <date value="2012-01-04"/> 
  <publisher value="ACME Corporation"/> 
  <contact> 
    <name value="System Administrator"/> 
    <telecom> 
      <system value="email"/> 
      <value value="wile@acme.org"/> 
    </telecom> 
  </contact> 
  <description value="This is the FHIR capability statement for the main EHR at ACME for the private
   interface - it does not describe the public interface"/> 
  <useContext> 
    <code> 
      <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/> 
      <code value="focus"/> 
    </code> 
    <valueCodeableConcept> 
      <coding> 
        <system value="http://terminology.hl7.org/CodeSystem/variant-state"/> 
        <code value="positive"/> 
      </coding> 
    </valueCodeableConcept> 
  </useContext> 
  <jurisdiction> 
    <coding> 
      <system value="urn:iso:std:iso:3166"/> 
      <code value="US"/> 
      <display value="United States of America (the)"/> 
    </coding> 
  </jurisdiction> 
  <purpose value="Main EHR capability statement, published for contracting and operational support"/> 
  <copyright value="Copyright © Acme Healthcare and GoodCorp EHR Systems"/> 
  <kind value="instance"/> 
  <instantiates value="http://ihe.org/fhir/CapabilityStatement/pixm-client"/> 
  <software> 
    <name value="EHR"/> 
    <version value="0.00.020.2134"/> 
    <releaseDate value="2012-01-04"/> 
  </software> 
  <implementation> 
    <description value="main EHR at ACME"/> 
    <url value="http://10.2.3.4/fhir"/> 
  </implementation> 
  <fhirVersion value="5.0.0"/> 
  <format value="xml"/> 
  <format value="json"/> 
  <patchFormat value="application/xml-patch+xml"/> 
  <patchFormat value="application/json-patch+json"/> 
  <acceptLanguage value="en"/> 
  <acceptLanguage value="es"/> 
  <implementationGuide value="http://example.org/fhir/us/lab"/> 
  <rest> 
    <mode value="server"/> 
    <documentation value="Main FHIR endpoint for acem health"/> 
    <security> 
      <cors value="true"/> 
      <service> 
        <coding> 
          <system value="http://hl7.org/fhir/restful-security-service"/> 
          <code value="SMART-on-FHIR"/> 
        </coding> 
      </service> 
      <description value="See Smart on FHIR documentation"/> 
    </security> 
    <resource> 
      <type value="Patient"/> 
      <profile value="http://registry.fhir.org/r5/StructureDefinition/7896271d-57f6-4231-89dc-dcc91eab2416"/> 
      <supportedProfile value="http://registry.fhir.org/r5/StructureDefinition/00ab9e7a-06c7-4f77-9234-4154ca1e3347"/> 
      <documentation value="This server does not let the clients create identities."/> 
      <interaction> 
        <code value="read"/> 
      </interaction> 
      <interaction> 
        <code value="vread"/> 
        <documentation value="Only supported for patient records since 12-Dec 2012"/> 
      </interaction> 
      <interaction> 
        <code value="update"/> 
      </interaction> 
      <interaction> 
        <code value="history-instance"/> 
      </interaction> 
      <interaction> 
        <code value="create"/> 
      </interaction> 
      <interaction> 
        <code value="history-type"/> 
      </interaction> 
      <versioning value="versioned-update"/> 
      <readHistory value="true"/> 
      <updateCreate value="false"/> 
      <conditionalCreate value="true"/> 
      <conditionalRead value="full-support"/> 
      <conditionalUpdate value="false"/> 
      <conditionalPatch value="false"/> 
      <conditionalDelete value="not-supported"/> 
      <searchInclude value="Patient:organization"/> 
      <searchRevInclude value="Person:patient"/> 
      <searchParam> 
        <name value="identifier"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Patient-identifier"/> 
        <type value="token"/> 
        <documentation value="Only supports search by institution MRN"/> 
      </searchParam> 
      <searchParam> 
        <name value="general-practitioner"/> 
        <definition value="http://hl7.org/fhir/SearchParameter/Patient-general-practitioner"/> 
        <type value="reference"/> 
      </searchParam> 
    </resource> 
    <interaction> 
      <code value="transaction"/> 
    </interaction> 
    <interaction> 
      <code value="history-system"/> 
    </interaction> 
    <compartment value="http://hl7.org/fhir/CompartmentDefinition/patient"/> 
  </rest> 
  <messaging> 
    <endpoint> 
      <protocol> 
        <system value="http://hl7.org/fhir/message-transport"/> 
        <code value="mllp"/> 
      </protocol> 
      <address value="mllp:10.1.1.10:9234"/> 
    </endpoint> 
    <reliableCache value="30"/> 
    <documentation value="ADT A08 equivalent for external system notifications"/> 
    <supportedMessage> 
      <mode value="receiver"/> 
      <definition value="http://hl7.org/fhir/MessageDefinition/example"/> 
    </supportedMessage> 
  </messaging> 
  <document> 
    <mode value="consumer"/> 
    <documentation value="Basic rules for all documents in the EHR system"/> 
    <profile value="http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4
    ea1-911a-721a60663796"/> 
  </document> 
</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.