<?xml version="1.0" encoding="UTF-8"?>

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="mpi-server"/>
  <text>
    <status value="generated"/><div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">MPI-Server CapabilityStatement</h2><ul><li><b>Official URL:</b><code>http://safhir.io/ig/onyx-mpi/CapabilityStatement/mpi-server</code></li><li><b>Implementation Guide Version:</b> 0.1.0</li><li><b>FHIR Version:</b> 4.0.1</li><li><b>Intended Use:</b> Requirements</li><li><b>Supported Formats:</b>
				
                    XML, JSON
				
				</li><li><b>Supported Patch Formats:</b>
				
                    APPLICATION/JSON-PATCH+JSON
				
				</li><li><b>Published:</b> 2022-07-13</li><li><b>Published by:</b> Onyx Technology, LLC</li><li><b>Status:</b> Experimental</li></ul><p>This Section describes the expected capabilities of the MPI Server actor which is responsible for providing responses to the queries submitted by the MPI Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by MPI Server are defined.</p>  <!-- No support expectation extension --><h3 id="igs" class="no_toc">Support the Following Implementation Guides:</h3><ul><li><a href="http://safhir.io/ig/onyx-mpi/ImplementationGuide/safhir.io.onyx-mpi">Onyx Master Patient Index | DSTU1</a></li></ul>  <!-- REST Behavior --><h3 id="behavior">FHIR Server RESTful Capabilities</h3><p>MPI Server  <strong>SHALL</strong>:</p><ol><li>Support all profiles defined in this Implementation Guide.</li><li>Implement the RESTful behavior according to the FHIR specification.</li><li>Return the following response classes:
<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></ul>
</li><li>Support json source formats for all MPI interactions.</li><li>Support the searchParameters on each profile individually and in combination.</li></ol><p>MPI Server <strong>SHOULD</strong>:</p><ol><li>Support xml source formats for all MPI interactions.</li></ol><h3 id="resource--details" class="no_toc">RESTful Capabilities by Resource/Profile:</h3><p><strong>Summary</strong></p></div>
  </text>
  <url value="http://ig.fhir.safhir.io/ig/onyx-mpi/CapabilityStatement/mpi-server"/>
  <version value="0.1.0"/>
  <name value="MPIServerCapabilityStatement"/>
  <status value="draft"/>
  <experimental value="false"/>
  <date value="2022-07-13"/>
  <publisher value="HL7 Financial Management Working Group"/>
  <contact>
    <name value="HL7 Financial Management Working Group"/>
    <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="Onyx Technology, LLC"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.onyxhealth.io"/>
    </telecom>
  </contact>
  <description value="This Section describes the expected capabilities of the MPI Server actor which is responsible for providing responses to the queries submitted by MPI Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by MPI Server are defined."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <instantiates value="http://safhir.io/ig/onyx-ny-mpi/CapabilityStatement/mpi-server"/>
  <fhirVersion value="4.0.1"/>
  <format value="xml"/>
  <format value="json"/>
  <patchFormat value="application/json-patch+json"/>
  <implementationGuide value="http://safhir.io/ig/onyx-ny-mpi/ImplementationGuide/onyx-ny-mpi"/>
  <rest>
    <mode value="server"/>
    <documentation value="The MPI Server **SHALL**: &#xA;1. Support the Master Patient profile that is based on US Core 3.1.1.&#xA;2. Implement the RESTful behavior according to the FHIR specification.&#xA;3. Support json source formats for all MPI interactions. &#xA;4. Return the following response classes:&#xA;  - (Status 400): invalid parameter&#xA;  - (Status 401/4xx): unauthorized request&#xA;  - (Status 403): insufficient scope &#xA;  - (Status 404): unknown resource &#xA;  - (Status 410): deleted resource."/>
    <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>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <extension url="required">
          <valueString value="birthdate"/>
        </extension>
        <extension url="required">
          <valueString value="family"/>
        </extension>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <extension url="required">
          <valueString value="family"/>
        </extension>
        <extension url="required">
          <valueString value="gender"/>
        </extension>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <extension url="required">
          <valueString value="birthdate"/>
        </extension>
        <extension url="required">
          <valueString value="name"/>
        </extension>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <extension url="required">
          <valueString value="gender"/>
        </extension>
        <extension url="required">
          <valueString value="name"/>
        </extension>
      </extension>
      <type value="Patient"/>
      <supportedProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
      <referencePolicy value="resolves"/>
      <searchRevInclude value="Provenance:target"/>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="_id"/>
        <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <name value="birthdate"/>
        <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <name value="family"/>
        <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-family"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <name value="gender"/>
        <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <name value="given"/>
        <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-given"/>
        <type value="string"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="name"/>
        <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-name"/>
        <type value="string"/>
      </searchParam>
      <operation>
        <name value="member-match"/>
        <definition value="http://hl7.org/fhir/us/davinci-hrex/OperationDefinition/member-match"/>
      </operation>
    </resource>
    <resource>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="Provenance"/>
      <supportedProfile value="http://hl7.org/fhir/us/davinci-pdex/StructureDefinition/pdex-provenance"/>
      <supportedProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"/>
      <documentation value="If a system receives a provider in `Provenance.agent.who` as free text they must capture who sent them the information as the organization. On request they **SHALL** provide this organization as the source and **MAY** include the free text provider."/>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="patch"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
      </interaction>
      <interaction>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-type"/>
      </interaction>
      <referencePolicy value="resolves"/>
    </resource>
    <resource>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHOULD"/>
      </extension>
      <type value="ValueSet"/>
      <operation>
        <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="expand"/>
        <definition value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/>
        <documentation value="A client can determine the note and report types support by a server by invoking the standard FHIR Value Set Expansion ($expand) operation defined in the FHIR R4 specification. Because servers may support different read and write formats, it also is used to determine the formats (for example, text, pdf) the server supports read and write transactions."/>
      </operation>
    </resource>
    <interaction>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="transaction"/>
    </interaction>
    <interaction>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="batch"/>
    </interaction>
    <interaction>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="search-system"/>
    </interaction>
    <interaction>
      <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="MAY"/>
      </extension>
      <code value="history-system"/>
    </interaction>
  </rest>
</CapabilityStatement>