Da Vinci Payer Data Exchange
2.1.1 - STU 2.1

Da Vinci Payer Data Exchange, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-epdx/ and changes regularly. See the Directory of published versions

## : PDex Payer-Access Server CapabilityStatement - JSON Representation

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

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "pdex-payer-access-server",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement pdex-payer-access-server</b></p><a name=\"pdex-payer-access-server\"> </a><a name=\"hcpdex-payer-access-server\"> </a><h2 id=\"title\">PDex Payer Access Server CapabilityStatement</h2><ul><li>Implementation Guide Version: 2.1.1 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code></li><li>Supported Patch Formats: <code>application/json-patch+json</code></li><li>Published on: 2024-05-02 </li><li>Published by: HL7 International / Financial Management </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><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li><a href=\"index.html\">http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex|2.1.0</a></li></ul><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>The PDex Payer Access Server <strong>SHALL</strong>:</p>\n<ol>\n<li>Support the US Core 3.1.1 or US Core 6.1.0 resources accessed via the Group resource.</li>\n<li>Implement the RESTful behavior according to the FHIR specification for bulk asynchronous access.</li>\n<li>Support json source formats for all US Core and PDex interactions.</li>\n<li>Return the following response classes:</li>\n</ol>\n<ul>\n<li>(Status 400): invalid parameter</li>\n<li>(Status 401/4xx): unauthorized request</li>\n<li>(Status 403): insufficient scope</li>\n<li>(Status 404): unknown resource</li>\n<li>(Status 410): deleted resource.</li>\n</ul>\n<p>The PDex Payer Access Server <strong>SHOULD</strong>:</p>\n<ol>\n<li>Identify the US Core profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<li>See the <a href=\"http://hl7.org/fhir/us/core/security.html\">US Core Security Considerations</a> section for requirements and recommendations. 2. A server <strong>SHALL</strong> reject any unauthorized requests by returning an <code>HTTP 401</code> unauthorized response code.</li>\n</ol>\n</div></blockquote></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><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 past versions of resources (vread interaction)\">V-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=\"GET changes to a resource (history interaction on instance)\">H-I</b></th><th class=\"text-center\"><b title=\"GET changes for all resources of the type (history interaction on type)\">H-T</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=\"#Group1-1\">Group</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-pdex-member-match-group.html\">PDex Member Match Group</a></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"><span title=\"MAY\">y?</span></td><td>identifier, characteristic</td><td/><td/><td><code>$bulk-member-match</code>, <code>$davinci-data-export</code></td></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Group1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Group</h4></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/group.html\">Group</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><strong>SHALL</strong> support <br/><code>search-type</code><div><p>Allows discovery of existing groups. SHOULD be limited to groups a requestor is permitted to access.</p>\n</div><code>read</code><div><p>Allows retrieval of a specific Group Resource.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>vread</code><div><p>Allows retrieval of a historical version of a Group Resource.</p>\n</div><code>history-instance</code><div><p>Allows review of changes to a Group Resource over time.</p>\n</div></li><li><strong>MAY</strong> support <br/><code>history-type</code><div><p>Retrieve the change history fora Group Resource.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-pdex-member-match-group.html\">PDex Member Match Group</a></p></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/group.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>The client <strong>SHALL</strong> provide at least a code value and <strong>MAY</strong> provide both the system and code values.</p>\n<p>The server <strong>SHALL</strong> support both.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/group.html#search\">characteristic</a></td><td><code>token</code></td><td><div><p>A common characteristic of all members of a group.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended 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><a href=\"OperationDefinition-BulkMemberMatch.html\">$bulk-member-match</a></td><td><div><p>Client will submit multi-member-match-request bundle. Server will respond with a multi-member-match-response and instantiate a Group resource conforming to the PDexMemberMatchGroup that contains a set of matched members that the Server identified.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/us/davinci-atr/STU2.1/OperationDefinition-davinci-data-export.html\">$davinci-data-export</a></td><td><div><p>Each DaVinci use case as part of its implementation guide can define the exportType parameter and the behavior expected.</p>\n</div></td></tr></tbody></table></div></div></div></div></div></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "fm"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 2,
          "_valueInteger" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex"
              }
            ]
          }
        },
        {
          "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/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex"
              }
            ]
          }
        }
      ],
      "url" : "http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-payer-access-server",
      "version" : "2.1.1",
      "name" : "PdexPayerAccessServerCapabilityStatement",
      "title" : "PDex Payer Access Server CapabilityStatement",
      "status" : "active",
      "experimental" : false,
      "date" : "2024-05-02",
      "publisher" : "HL7 International / Financial Management",
      "contact" : [
        {
          "name" : "HL7 International / Financial Management",
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/fm"
            },
            {
              "system" : "email",
              "value" : "fm@lists.HL7.org"
            }
          ]
        },
        {
          "name" : "Mark Scrimshire (mark.scrimshire@onyxhealth.io)",
          "telecom" : [
            {
              "system" : "email",
              "value" : "mailto:mark.scrimshire@onyxhealth.io"
            }
          ]
        },
        {
          "name" : "HL7 International - Financial Management",
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/fm"
            }
          ]
        }
      ],
      "description" : "This Section describes the expected capabilities of the PDex Payer Access Server actor which is responsible for providing responses to the queries submitted by the PDex Payer Access Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by PDex Payer Access Servers are defined. PDex Payer Access Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "US",
              "display" : "United States of America"
            }
          ]
        }
      ],
      "copyright" : "Used by permission of HL7 International, all rights reserved Creative Commons License",
      "kind" : "requirements",
      "fhirVersion" : "4.0.1",
      "format" : [
        "json"
      ],
      "patchFormat" : [
        "application/json-patch+json"
      ],
      "implementationGuide" : [
        🔗 "http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex|2.1.0"
      ],
      "rest" : [
        {
          "mode" : "server",
          "documentation" : "The PDex Payer Access Server **SHALL**: \n1. Support the US Core 3.1.1 or US Core 6.1.0 resources accessed via the Group resource.\n2. Implement the RESTful behavior according to the FHIR specification for bulk asynchronous access.\n3. Support json source formats for all US Core and PDex interactions. \n4. Return the following response classes:\n  - (Status 400): invalid parameter\n  - (Status 401/4xx): unauthorized request\n  - (Status 403): insufficient scope \n  - (Status 404): unknown resource \n  - (Status 410): deleted resource.\n\nThe PDex Payer Access Server **SHOULD**: \n1. Identify the US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance.",
          "security" : {
            "description" : "1. See the [US Core Security Considerations](http://hl7.org/fhir/us/core/security.html) section for requirements and recommendations. 2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` unauthorized response code."
          },
          "resource" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "type" : "Group",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-member-match-group"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "search-type",
                  "documentation" : "Allows discovery of existing groups. SHOULD be limited to groups a requestor is permitted to access."
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read",
                  "documentation" : "Allows retrieval of a specific Group Resource."
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "code" : "vread",
                  "documentation" : "Allows retrieval of a historical version of a Group Resource."
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "code" : "history-instance",
                  "documentation" : "Allows review of changes to a Group Resource over time."
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "MAY"
                    }
                  ],
                  "code" : "history-type",
                  "documentation" : "Retrieve the change history fora Group Resource."
                }
              ],
              "searchParam" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "identifier",
                  "definition" : "http://hl7.org/fhir/SearchParameter/Group-identifier",
                  "type" : "token",
                  "documentation" : "The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.\n\nThe server **SHALL** support both."
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "characteristic",
                  "definition" : "http://hl7.org/fhir/SearchParameter/Group-characteristic",
                  "type" : "token",
                  "documentation" : "A common characteristic of all members of a group."
                }
              ],
              "operation" : [
                {
                  "name" : "bulk-member-match",
                  "definition" : "http://hl7.org/fhir/us/davinci-pdex/OperationDefinition/BulkMemberMatch",
                  "documentation" : "Client will submit multi-member-match-request bundle. Server will respond with a multi-member-match-response and instantiate a Group resource conforming to the PDexMemberMatchGroup that contains a set of matched members that the Server identified."
                },
                {
                  "name" : "davinci-data-export",
                  "definition" : "http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export",
                  "documentation" : "Each DaVinci use case as part of its implementation guide can define the exportType parameter and the behavior expected."
                }
              ]
            }
          ]
        }
      ]
    }