Consumer Real-Time Pharmacy Benefit Check FHIR IG
2.0.0 - CI Build

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

Page standards status: Trial-use | Maturity Level: 4

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "rtpbc-responder",
      "language" : "en",
      "text" : {
        "status" : "extensions",
        "div" : "<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>\n</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>\n</div></blockquote><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$process-message</td><td><div/></td></tr></tbody></table></div></div></div></div></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "phx"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 4,
          "_valueInteger" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/carin-rtpbc/ImplementationGuide/hl7.fhir.us.carin-rtpbc"
              }
            ]
          }
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
          "valueCode" : "trial-use",
          "_valueCode" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/carin-rtpbc/ImplementationGuide/hl7.fhir.us.carin-rtpbc"
              }
            ]
          }
        }
      ],
      "url" : "http://hl7.org/fhir/us/carin-rtpbc/CapabilityStatement/rtpbc-responder",
      "version" : "2.0.0",
      "name" : "RtpbcResponderCapabilityStatement",
      "title" : "RTPBC Responder Capability Statement",
      "status" : "active",
      "experimental" : false,
      "date" : "2019-12-08T00:00:00-05:00",
      "publisher" : "HL7 International / Pharmacy",
      "contact" : [
        {
          "name" : "HL7 International / Pharmacy",
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/medication"
            }
          ]
        },
        {
          "name" : "Frank McKinney",
          "telecom" : [
            {
              "system" : "email",
              "value" : "fm@frankmckinney.com"
            }
          ]
        }
      ],
      "description" : "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" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "United States of America"
            }
          ]
        }
      ],
      "kind" : "requirements",
      "fhirVersion" : "4.0.1",
      "format" : [
        "xml",
        "json"
      ],
      "patchFormat" : [
        "application/json-patch+json"
      ],
      "rest" : [
        {
          "mode" : "server",
          "documentation" : "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" : "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."
          },
          "operation" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "process-message",
              "definition" : "http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message"
            }
          ]
        }
      ]
    }