CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.1-ballot-2: DSTU 4 Ballot 3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

: PPQm Policy Source and Consumer (client) - XML Representation

Active as of 2024-03-19

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="CH.PPQm.PolicySourceConsumer"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement CH.PPQm.PolicySourceConsumer</b></p><a name="CH.PPQm.PolicySourceConsumer"> </a><a name="hcCH.PPQm.PolicySourceConsumer"> </a><a name="CH.PPQm.PolicySourceConsumer-en-US"> </a><h2 id="title">PPQm Policy Source and Consumer (client)</h2><ul><li>Implementation Guide Version: 4.0.1-ballot-2 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-03-19 </li><li>Published by: eHealth Suisse </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>client</code></h3></div><div class="panel-body"><div><p>CH:PPQm endpoints</p>
</div><div class="lead"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction described as follows:<div><p>Only the PPQ-4 transaction is supported.</p>
</div></li></ul></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 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><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="#Consent1-1">Consent</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-PpqmConsent.html">CH PPQm Consent</a></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center"></td><td class="text-center">y</td><td>patient:identifier, identifier</td><td/><td/><td/></tr><tr><td><a href="#Bundle1-2">Bundle</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-PpqmFeedRequestBundle.html">CH PPQm Feed Request Bundle</a><br/>  <a href="StructureDefinition-PpqmRetrieveResponseBundle.html">CH PPQm Retrieve Response Bundle</a></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Consent1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Consent</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/consent.html">Consent</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 <br/><code>create</code><div><p>PPQ-3 POST — Add Policy Set</p>
</div><code>search-type</code><div><p>PPQ-5 — Retrieve Policy Set</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-PpqmConsent.html">CH PPQm Consent</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>patient:identifier</td><td><code>token</code></td><td><div><p>PPQ-5 — Query by Patient ID</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>PPQ-5 — Query by Policy Set ID</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Bundle1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Bundle</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/bundle.html">Bundle</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/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-PpqmFeedRequestBundle.html">CH PPQm Feed Request Bundle</a><br/><a href="StructureDefinition-PpqmRetrieveResponseBundle.html">CH PPQm Retrieve Response Bundle</a></p></div></div><p/></div></div></div></div>
  </text>
  <url
       value="http://fhir.ch/ig/ch-epr-fhir/CapabilityStatement/CH.PPQm.PolicySourceConsumer"/>
  <version value="4.0.1-ballot-2"/>
  <name value="CH_PPQm_Policy_Source_Consumer"/>
  <title value="PPQm Policy Source and Consumer (client)"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-03-19"/>
  <publisher value="eHealth Suisse"/>
  <contact>
    <name value="eHealth Suisse"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.e-health-suisse.ch"/>
    </telecom>
  </contact>
  <description
               value="CapabilityStatement for the Policy Source and Policy Consumer actors in the CH:PPQm profile (client)."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="CH"/>
    </coding>
  </jurisdiction>
  <copyright value="CC0-1.0"/>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <rest>
    <mode value="client"/>
    <documentation value="CH:PPQm endpoints"/>
    <resource>
      <type value="Consent"/>
      <supportedProfile
                        value="http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmConsent"/>
      <interaction>
        <code value="create"/>
        <documentation value="PPQ-3 POST — Add Policy Set"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
        <documentation value="PPQ-5 — Retrieve Policy Set"/>
      </interaction>
      <versioning value="no-version"/>
      <conditionalUpdate value="true"/>
      <conditionalDelete value="single"/>
      <searchParam>
        <name value="patient:identifier"/>
        <type value="token"/>
        <documentation value="PPQ-5 — Query by Patient ID"/>
      </searchParam>
      <searchParam>
        <name value="identifier"/>
        <type value="token"/>
        <documentation value="PPQ-5 — Query by Policy Set ID"/>
      </searchParam>
    </resource>
    <resource>
      <type value="Bundle"/>
      <supportedProfile
                        value="http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmFeedRequestBundle"/>
      <supportedProfile
                        value="http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/PpqmRetrieveResponseBundle"/>
    </resource>
    <interaction>
      <code value="transaction"/>
      <documentation value="Only the PPQ-4 transaction is supported."/>
    </interaction>
  </rest>
</CapabilityStatement>