Bidirectional Services eReferral (BSeR)
2.0.0-ballot - STU2 United States of America flag

Bidirectional Services eReferral (BSeR), published by HL7 Public Health Working Group. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/bser/ and changes regularly. See the Directory of published versions

: Capability Statement -BSeR - XML Representation

Active as of 2019-11-26

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="capabilitystatement-bser"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">Capability Statement BSeR</h2><ul><li>Implementation Guide Version: 2.0.0-ballot</li><li>FHIR Version: 4.0.0</li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2019-11-26</li><li>Published by: HL7 Public Health Working Group</li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as &quot;SHALL NOT&quot;. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><h3 id="rest1">REST Configuration 1</h3><div class="panel panel-default"><div class="panel-heading"><h4 id="mode1" class="panel-title">Mode: <code>client</code></h4></div><div class="panel-body"><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h4 id="resourcesCap1">Capabilities by Resource/Profile</h4><h5 id="resourcesSummary1">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th class="text-center"><b title="DELETE a resource (delete interaction)">D</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Observation1-1">Observation</a></td><td>Supported profiles:<br/>  <a href="StructureDefinition-bser-referral-observation.html">BSeR Referral Observation</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Coverage1-2">Coverage</a></td><td>Supported profiles:<br/>  <a href="StructureDefinition-BSeR-Coverage.html">BSeR Coverage</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Condition1-3">Condition</a></td><td><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-condition-problems-health-concerns.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#MedicationRequest1-4">MedicationRequest</a></td><td><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-medicationrequest.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h5 id="Observation1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Observation</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/observation.html">Observation</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-bser-referral-observation.html">http://hl7.org/fhir/us/bser/StructureDefinition/bser-referral-observation</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h5 id="Coverage1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Coverage</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/coverage.html">Coverage</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-BSeR-Coverage.html">http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Coverage</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h5 id="Condition1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Condition</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-condition-problems-health-concerns.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h5 id="MedicationRequest1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>MedicationRequest</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-medicationrequest.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/></div></div></div><h3 id="rest2">REST Configuration 2</h3><div class="panel panel-default"><div class="panel-heading"><h4 id="mode2" class="panel-title">Mode: <code>server</code></h4></div><div class="panel-body"><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h4 id="resourcesCap2">Capabilities by Resource/Profile</h4><h5 id="resourcesSummary2">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th class="text-center"><b title="DELETE a resource (delete interaction)">D</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Observation2-1">Observation</a></td><td>Supported profiles:<br/>  <a href="StructureDefinition-bser-referral-observation.html">BSeR Referral Observation</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Coverage2-2">Coverage</a></td><td>Supported profiles:<br/>  <a href="StructureDefinition-BSeR-Coverage.html">BSeR Coverage</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Condition2-3">Condition</a></td><td><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-condition-problems-health-concerns.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#MedicationRequest2-4">MedicationRequest</a></td><td><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-medicationrequest.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest</a></td><td>y</td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h5 id="Observation2-1" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Observation</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/observation.html">Observation</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-bser-referral-observation.html">http://hl7.org/fhir/us/bser/StructureDefinition/bser-referral-observation</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h5 id="Coverage2-2" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Coverage</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/coverage.html">Coverage</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-BSeR-Coverage.html">http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Coverage</a></p></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h5 id="Condition2-3" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>Condition</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-condition-problems-health-concerns.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h5 id="MedicationRequest2-4" class="panel-title"><span style="float: right;">Resource Conformance: supported</span>MedicationRequest</h5></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="http://hl7.org/fhir/us/core/STU5.0.1/StructureDefinition-us-core-medicationrequest.html">http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>create</code>, <code>read</code>, <code>update</code>, <code>delete</code>.</li></ul></div></div><p/></div></div></div></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/bser/CapabilityStatement/capabilitystatement-bser"/>
  <version value="2.0.0-ballot"/>
  <name value="CapabilityStatement_BSeR"/>
  <title value="Capability Statement BSeR"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2019-11-26"/>
  <publisher value="HL7 Public Health Working Group"/>
  <contact>
    <name value="HL7 Public Health Working Group"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/pher"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="pher@lists.HL7.org"/>
    </telecom>
  </contact>
  <description
               value="This resource defines the expected capabilities for both client and server participating in BSeR exchange"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.0"/>
  <format value="xml"/>
  <format value="json"/>
  <rest>
    <mode value="client"/>
    <resource>
      <type value="Observation"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/bser/StructureDefinition/bser-referral-observation"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="Coverage"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Coverage"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="Condition"/>
      <profile
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="MedicationRequest"/>
      <profile
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
  </rest>
  <rest>
    <mode value="server"/>
    <resource>
      <type value="Observation"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/bser/StructureDefinition/bser-referral-observation"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="Coverage"/>
      <supportedProfile
                        value="http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-Coverage"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="Condition"/>
      <profile
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
    <resource>
      <type value="MedicationRequest"/>
      <profile
               value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"/>
      <interaction>
        <code value="create"/>
      </interaction>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="update"/>
      </interaction>
      <interaction>
        <code value="delete"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>