Order Catalog Implementation Guide
current - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). 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 medical device catalog - XML Representation

Active as of 2022-10-21

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="cs-device-custodian"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>CapabilityStatement4DeviceCustodian</h2><div><p>This Section describes the expected capabilities of the Custodian of a catalog of medical devices. This role is responsible for providing responses to the queries submitted by the catalog consumers.</p>
<p>The DeviceDefinition Resource is the focal Resource describing a model of device in the catalog.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td><div><p>The Custodian of a catalog of medical devices <strong>SHALL</strong>:</p>
<ol>
<li>Support profiles CatalogHeader, DeviceModel 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 medical devices <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></td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET past versions of resources (vread interaction)">V-Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr><tr><td>DeviceDefinition</td><td>Supported profiles:<br/>  <a href="StructureDefinition-DeviceModel.html">Device Model</a></td><td>y</td><td>y</td><td>y</td><td></td><td></td></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-device-custodian"/>
  <version value="current"/>
  <name value="CapabilityStatement4DeviceCustodian"/>
  <title
         value="CapabilityStatement for custodian of catalog of medical devices"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2022-10-21"/>
  <publisher value="HL7 International - Orders and Observations Work Group"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/Special/committees/orders"/>
    </telecom>
  </contact>
  <description
               value="This Section describes the expected capabilities of the Custodian of a catalog of medical devices. This role is responsible for providing responses to the queries submitted by the catalog consumers. 

The DeviceDefinition Resource is the focal Resource describing a model of device 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-ballot"/>
  <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 medical devices **SHALL**:

1. Support profiles CatalogHeader, DeviceModel 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 medical devices **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="DeviceDefinition"/>
      <supportedProfile
                        value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DeviceModel"/>
      <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>