Order Catalog Implementation Guide
1.0.0-ballot - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

: Custodian of medication catalog - XML Representation

Page standards status: Trial-use Maturity Level: 2

Raw xml | Download


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="cs-drug-custodian"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement cs-drug-custodian</b></p><a name="cs-drug-custodian"> </a><a name="hccs-drug-custodian"> </a><a name="cs-drug-custodian-en-US"> </a><h2 id="title">CapabilityStatement for custodian of catalog of medications</h2><ul><li>Implementation Guide Version: 1.0.0-ballot </li><li>FHIR Version: 5.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2022-09-16 </li><li>Published by: HL7 International / Orders and Observations </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/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog</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 Custodian of a catalog of medications <strong>SHALL</strong>:</p>
<ol>
<li>Support profiles CatalogHeader, DrugKnowledge, DrugPackage 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>
<li>(Status 410): deleted resource.</li>
</ul>
</li>
<li>Support json source formats for all order-catalog interactions.</li>
<li>Identify the order-catalog  profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>
<li>Support the searchParameters on each profile  individually and in combination.</li>
</ol>
<p>The Custodian of a catalog of medications <strong>SHOULD</strong>:</p>
<ol>
<li>Support xml source formats for all order-catalog interactions.</li>
<li>support the Catalog profile of the Composition Resource in the core standard</li>
</ol>
</div><div class="lead"><em>Security</em></div><blockquote><div><ol>
<li>A custodian <strong>SHALL</strong> reject any unauthorized requests by returning an HTTP 401 &quot;Unauthorized&quot;, HTTP 403 &quot;Forbidden&quot;, or HTTP 404 &quot;Not Found&quot; .</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><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="#MedicationKnowledge1-1">MedicationKnowledge</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-DrugKnowledge.html">item in a catalog of drugs</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 class="text-center"/><td>_id, _lastUpdated</td><td><code>iterate=*</code></td><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="MedicationKnowledge1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>MedicationKnowledge</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/medicationknowledge.html">MedicationKnowledge</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/><code>enforced</code></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li><li><strong>SHOULD</strong> support <code>vread</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-DrugKnowledge.html">item in a catalog of drugs</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>_id</td><td><code>token</code></td><td><div><p>http://hl7.org/fhir/2022Sep/search.html#id</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>http://hl7.org/fhir/2022Sep/search.html#lastUpdated</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="oo"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"/>
      </extension>
    </valueInteger>
  </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/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-drug-custodian"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.40.999.13.2"/>
  </identifier>
  <version value="1.0.0-ballot"/>
  <name value="CapabilityStatement4DrugCustodian"/>
  <title value="CapabilityStatement for custodian of catalog of medications"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2022-09-16"/>
  <publisher value="HL7 International / Orders and Observations"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/orders"/>
    </telecom>
  </contact>
  <description
               value="This Section describes the expected capabilities of the Custodian of a catalog of medications. This role is responsible for providing responses to the queries submitted by the catalog consumers. 

The MedicationKnowledge Resource is the focal Resource gathering all knowledge and information details about a medication in the catalog."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="5.0.0"/>
  <format value="xml"/>
  <format value="json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="The Custodian of a catalog of medications **SHALL**:

1. Support profiles CatalogHeader, DrugKnowledge, DrugPackage defined in this Implementation Guide..
2.  Implement the RESTful behavior according to the FHIR specification.
3. 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.
4. Support json source formats for all order-catalog interactions.
5. Identify the order-catalog  profiles supported as part of the FHIR `meta.profile` attribute for each instance.
6. Support the searchParameters on each profile  individually and in combination.

The Custodian of a catalog of medications **SHOULD**:

1. Support xml source formats for all order-catalog interactions.
2. support the Catalog profile of the Composition Resource in the core standard
"/>
    <security>
      <description
                   value="1. A custodian **SHALL** reject any unauthorized requests by returning an HTTP 401 &quot;Unauthorized&quot;, HTTP 403 &quot;Forbidden&quot;, or HTTP 404 &quot;Not Found&quot; ."/>
    </security>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="MedicationKnowledge"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DrugKnowledge"/>
      <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>
      <referencePolicy value="enforced"/>
      <searchInclude value="iterate=*"/>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="_id"/>
        <type value="token"/>
        <documentation value="http://hl7.org/fhir/2022Sep/search.html#id"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="_lastUpdated"/>
        <type value="date"/>
        <documentation
                       value="http://hl7.org/fhir/2022Sep/search.html#lastUpdated"/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>