Consumer Real-Time Pharmacy Benefit Check FHIR IG
2.0.0 - CI Build United States of America flag

Consumer Real-Time Pharmacy Benefit Check FHIR IG, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-rtpbc/ and changes regularly. See the Directory of published versions

: RTPBC Responder Capability Statement - XML Representation

Page standards status: Trial-use Maturity Level: 4

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="rtpbc-responder"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement rtpbc-responder</b></p><a name="rtpbc-responder"> </a><a name="hcrtpbc-responder"> </a><h2 id="title">RTPBC Responder Capability Statement</h2><ul><li>Implementation Guide Version: 2.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: <code>application/json-patch+json</code></li><li>Published on: 2019-12-08 00:00:00-0500 </li><li>Published by: HL7 International / Pharmacy </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 'SHALL NOT'. 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><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><p>RTPBC Responder <strong>SHALL</strong>: 1. Support the $process-message operation. 2. Support at least one use case defined in this IG and listed in the Use Cases section. 3. Implement the RESTful behavior according to the FHIR specification. 4. Support the JSON source format. 5. Provide on the server a CapabilityStatement identifying the profiles supported. RTPBC Responder <strong>SHOULD</strong>: 1. Support the XML source format. 2. Identify the RTPBC profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</p>
</div><div class="lead"><em>Security</em></div><blockquote><div><p>Implementers are expected to follow core FHIR security principles (https://www.hl7.org/fhir/security.html).In addition, the FHIR Security and Privacy Module (http://hl7.org/fhir/R4/secpriv-module.html) describes how to protect patient privacy. A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</p>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h3 id="operationsCap1">Operations</h3><h4 id="operationsSummary1">Use</h4></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="phx"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="4">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/carin-rtpbc/ImplementationGuide/hl7.fhir.us.carin-rtpbc"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/carin-rtpbc/ImplementationGuide/hl7.fhir.us.carin-rtpbc"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/us/carin-rtpbc/CapabilityStatement/rtpbc-responder"/>
  <version value="2.0.0"/>
  <name value="RtpbcResponderCapabilityStatement"/>
  <title value="RTPBC Responder Capability Statement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2019-12-08T00:00:00-05:00"/>
  <publisher value="HL7 International / Pharmacy"/>
  <contact>
    <name value="HL7 International / Pharmacy"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/medication"/>
    </telecom>
  </contact>
  <contact>
    <name value="Frank McKinney"/>
    <telecom>
      <system value="email"/>
      <value value="fm@frankmckinney.com"/>
    </telecom>
  </contact>
  <description
               value="This CapabilityStatement describes the expected capabilities of a server that is capable of responding to a Real-time Pharmacy Benefit Check (RTPBC) request transacted with the `$process-message` operation."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="xml"/>
  <format value="json"/>
  <patchFormat value="application/json-patch+json"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="RTPBC Responder **SHALL**: 1. Support the $process-message operation. 2. Support at least one use case defined in this IG and listed in the Use Cases section. 3. Implement the RESTful behavior according to the FHIR specification. 4. Support the JSON source format. 5. Provide on the server a CapabilityStatement identifying the profiles supported. RTPBC Responder **SHOULD**: 1. Support the XML source format. 2. Identify the RTPBC profiles supported as part of the FHIR `meta.profile` attribute for each instance."/>
    <security>
      <description
                   value="Implementers are expected to follow core FHIR security principles (https://www.hl7.org/fhir/security.html).In addition, the FHIR Security and Privacy Module (http://hl7.org/fhir/R4/secpriv-module.html) describes how to protect patient privacy. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."/>
    </security>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="process-message"/>
      <definition
                  value="http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"/>
    </operation>
  </rest>
</CapabilityStatement>