FHIR Implementation Guide for NJSAMS


1.0.0 - release

NJSAMS - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: NJSAMSCapabilities - XML Representation

Draft as of 2022-08-31

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="NJSAMSCapabilities"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement NJSAMSCapabilities</b></p><a name="NJSAMSCapabilities"> </a><a name="hcNJSAMSCapabilities"> </a><a name="NJSAMSCapabilities-en-US"> </a><h2 id="title"/><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/json+fhir</code>, <code>application/xml+fhir</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-08-31 </li><li>Published by: Division of Mental Health and Addiction Services (DMHAS) </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 class="lead"><em>Security</em></div><div class="row"><div class="col-lg-6">Enable CORS: no</div><div class="col-lg-6">Security services supported: <code>Basic</code></div></div><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 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="#Patient1-1">Patient</a></td><td><a href="StructureDefinition-NJSAMSBasePatient.html">https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSBasePatient</a><br/><em>Additional supported profiles:</em><br/>  <a href="StructureDefinition-NJSAMSPatient.html">NJSAMSPatient</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Encounter1-2">Encounter</a></td><td><a href="StructureDefinition-NJSAMSEncounter.html">https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSEncounter</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Coverage1-3">Coverage</a></td><td><a href="StructureDefinition-NJSAMSCoverage.html">https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSCoverage</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Organization1-4">Organization</a></td><td><a href="StructureDefinition-NJSAMSOrganization.html">https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSOrganization</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"></td><td class="text-center"></td><td></td><td/><td/><td/></tr><tr><td><a href="#Location1-5">Location</a></td><td><a href="StructureDefinition-NJSAMSLocation.html">https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSLocation</a></td><td class="text-center">y</td><td class="text-center">y</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="Patient1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Patient</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-NJSAMSBasePatient.html">NJSAMSBasePatient</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-NJSAMSPatient.html">NJSAMSPatient</a></p></div><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Encounter1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Encounter</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-NJSAMSEncounter.html">NJSAMSEncounter</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Coverage1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Coverage</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-NJSAMSCoverage.html">NJSAMSCoverage</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Organization1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Organization</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-NJSAMSOrganization.html">NJSAMSOrganization</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Location1-5" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Location</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-NJSAMSLocation.html">NJSAMSLocation</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div></div>
  </text>
  <url
       value="https://fhir.njsams.rutgers.edu/NJSAMS-fhir/CapabilityStatement/NJSAMSCapabilities"/>
  <version value="1.0.0"/>
  <name value="NJSAMSCapabilities"/>
  <status value="draft"/>
  <experimental value="false"/>
  <date value="2022-08-31"/>
  <publisher
             value="Division of Mental Health and Addiction Services (DMHAS)"/>
  <contact>
    <name value="Division of Mental Health and Addiction Services (DMHAS)"/>
    <telecom>
      <system value="url"/>
      <value value="http://dhs.nj.gov"/>
    </telecom>
  </contact>
  <kind value="capability"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/json+fhir"/>
  <format value="application/xml+fhir"/>
  <rest>
    <mode value="client"/>
    <security>
      <service>
        <coding>
          <code value="Basic"/>
        </coding>
      </service>
    </security>
    <resource>
      <type value="Patient"/>
      <profile
               value="https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSBasePatient"/>
      <supportedProfile
                        value="https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSPatient"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
    </resource>
    <resource>
      <type value="Encounter"/>
      <profile
               value="https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSEncounter"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
    </resource>
    <resource>
      <type value="Coverage"/>
      <profile
               value="https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSCoverage"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
    </resource>
    <resource>
      <type value="Organization"/>
      <profile
               value="https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSOrganization"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
    </resource>
    <resource>
      <type value="Location"/>
      <profile
               value="https://fhir.njsams.rutgers.edu/NJSAMS-fhir/StructureDefinition/NJSAMSLocation"/>
      <interaction>
        <code value="read"/>
      </interaction>
      <interaction>
        <code value="search-type"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>