Da Vinci Payer Data Exchange
2.1.0 - STU2 Ballot
Da Vinci Payer Data Exchange
2.1.0 - STU2 Ballot
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.0 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
| Page standards status: Trial-use |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="pdex-provider-access-server"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement pdex-provider-access-server</b></p><a name="pdex-provider-access-server"> </a><a name="hcpdex-provider-access-server"> </a><a name="pdex-provider-access-server-en-US"> </a><h2 id="title">PDex Provider Access Server CapabilityStatement</h2><ul><li>Implementation Guide Version: 2.1.0 </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>http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex|2.0.0</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 Provider Access Server <strong>SHALL</strong>:</p>
<ol>
<li>Support the US Core 3.1.1 or US Core 6.1.0 resources accessed via the Group resource.</li>
<li>Implement the RESTful behavior according to the FHIR specification for bulk asynchronous access.</li>
<li>Support json source formats for all US Core and PDex interactions.</li>
<li>Return the following response classes:</li>
</ol>
<ul>
<li>(Status 400): invalid parameter</li>
<li>(Status 401/4xx): unauthorized request</li>
<li>(Status 403): insufficient scope</li>
<li>(Status 404): unknown resource</li>
<li>(Status 410): deleted resource.</li>
</ul>
<p>The PDex Provider Access Server <strong>SHOULD</strong>:</p>
<ol>
<li>Identify the US Core profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>
</ol>
</div><div class="lead"><em>Security</em></div><blockquote><div><ol>
<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>
</ol>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div></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/> <a href="http://hl7.org/fhir/us/davinci-atr/STU2/StructureDefinition-atr-group.html">Davinci ATR Group</a><br/> <a href="StructureDefinition-pdex-provider-group.html">PDex Provider Group</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td>identifier, characteristic, Group-characteristic-value-reference</td><td/><td/><td><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>
</div><code>read</code><div><p>Allows retrieval of a specific Group Resource.</p>
</div></li><li><strong>SHOULD</strong> support <br/><code>vread</code><div><p>Allows retrieval of a historical version of a Group Resource.</p>
</div><code>history-instance</code><div><p>Allows review of changes to a Group Resource over time.</p>
</div></li><li><strong>MAY</strong> support <br/><code>history-type</code><div><p>Retrieve the change history fora Group Resource.</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="http://hl7.org/fhir/us/davinci-atr/STU2/StructureDefinition-atr-group.html">Davinci ATR Group</a><br/><a href="StructureDefinition-pdex-provider-group.html">PDex Provider 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>
<p>The server <strong>SHALL</strong> support both.</p>
</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>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/us/davinci-atr/STU2/SearchParameter-Group-characteristic-value-reference.html">Group-characteristic-value-reference</a></td><td><code>composite</code></td><td><div><p>multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true. multipleOr: The parameter may only have one value (no comma separators).</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </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="http://hl7.org/fhir/us/davinci-atr/STU2/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>
</div></td></tr></tbody></table></div></div></div></div></div></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="fm"/>
</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/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex"/>
</extension>
</valueCode>
</extension>
<url
value="http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-provider-access-server"/>
<version value="2.1.0"/>
<name value="PdexProviderAccessServerCapabilityStatement"/>
<title value="PDex Provider Access Server CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2024-05-02"/>
<publisher value="HL7 International / Financial Management"/>
<contact>
<name value="HL7 International / Financial Management"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/fm"/>
</telecom>
<telecom>
<system value="email"/>
<value value="fm@lists.HL7.org"/>
</telecom>
</contact>
<contact>
<name value="Mark Scrimshire (mark.scrimshire@onyxhealth.io)"/>
<telecom>
<system value="email"/>
<value value="mailto:mark.scrimshire@onyxhealth.io"/>
</telecom>
</contact>
<contact>
<name value="HL7 International - Financial Management"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/fm"/>
</telecom>
</contact>
<description
value="This Section describes the expected capabilities of the PDex Provider Access Server actor which is responsible for providing responses to the queries submitted by the PDex Provider Access Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by PDex Provider Access Servers are defined. PDex Provider 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 value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<copyright
value="Used by permission of HL7 International, all rights reserved Creative Commons License"/>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<patchFormat value="application/json-patch+json"/>
<implementationGuide
value="http://hl7.org/fhir/us/davinci-pdex/ImplementationGuide/hl7.fhir.us.davinci-pdex|2.0.0"/>
<rest>
<mode value="server"/>
<documentation
value="The PDex Provider Access Server **SHALL**:
1. Support the US Core 3.1.1 or US Core 6.1.0 resources accessed via the Group resource.
2. Implement the RESTful behavior according to the FHIR specification for bulk asynchronous access.
3. Support json source formats for all US Core and PDex interactions.
4. Return the following response classes:
- (Status 400): invalid parameter
- (Status 401/4xx): unauthorized request
- (Status 403): insufficient scope
- (Status 404): unknown resource
- (Status 410): deleted resource.
The PDex Provider Access Server **SHOULD**:
1. Identify the US Core profiles supported as part of the FHIR `meta.profile` attribute for each instance."/>
<security>
<description
value="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."/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Group"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-group"/>
<supportedProfile
value="http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provider-group"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows discovery of existing groups. SHOULD be limited to groups a requestor is permitted to access."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows retrieval of a specific Group Resource."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
<documentation
value="Allows retrieval of a historical version of a Group Resource."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
<documentation
value="Allows review of changes to a Group Resource over time."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="history-type"/>
<documentation
value="Retrieve the change history fora Group Resource."/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Group-identifier"/>
<type value="token"/>
<documentation
value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values.
The server **SHALL** support both."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="characteristic"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Group-characteristic"/>
<type value="token"/>
<documentation
value="A common characteristic of all members of a group."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="Group-characteristic-value-reference"/>
<definition
value="http://hl7.org/fhir/us/davinci-atr/SearchParameter/Group-characteristic-value-reference"/>
<type value="composite"/>
<documentation
value="multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true. multipleOr: The parameter may only have one value (no comma separators)."/>
</searchParam>
<operation>
<name value="davinci-data-export"/>
<definition
value="http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export"/>
<documentation
value="Each DaVinci use case as part of its implementation guide can define the exportType parameter and the behavior expected."/>
</operation>
</resource>
</rest>
</CapabilityStatement>
IG © 2024+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pdex#2.1.0 based on FHIR 4.0.1. Generated 2024-12-13
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change