Order Catalog Implementation Guide
1.0.0 - STU 1

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

## : Custodian of medical device catalog - JSON Representation

Page standards status: Trial-use | Maturity Level: 2

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "cs-device-custodian",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement cs-device-custodian</b></p><a name=\"cs-device-custodian\"> </a><a name=\"hccs-device-custodian\"> </a><h2 id=\"title\">CapabilityStatement for custodian of catalog of medical devices</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 5.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Published on: 2022-10-21 </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 medical devices <strong>SHALL</strong>:</p>\n<ol>\n<li>Support profiles CatalogHeader, DeviceModel defined in this Implementation Guide..</li>\n<li>Implement the RESTful behavior according to the FHIR specification.</li>\n<li>Return the following response classes:\n<ul>\n<li>(Status 400): invalid parameter</li>\n<li>(Status 401/4xx): unauthorized request</li>\n<li>(Status 403): insufficient scope</li>\n<li>(Status 404): unknown resource</li>\n<li>(Status 410): deleted resource.</li>\n</ul>\n</li>\n<li>Support json source formats for all order-catalog interactions.</li>\n<li>Identify the order-catalog  profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>\n<li>Support the searchParameters on each profile  individually and in combination.</li>\n</ol>\n<p>The Custodian of a catalog of medical devices <strong>SHOULD</strong>:</p>\n<ol>\n<li>Support xml source formats for all order-catalog interactions.</li>\n<li>support the Catalog profile of the Composition Resource in the core standard</li>\n</ol>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><ol>\n<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>\n</ol>\n</div></blockquote></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=\"#DeviceDefinition1-1\">DeviceDefinition</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-DeviceModel.html\">Device Model</a></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"><span title=\"SHOULD\">Y</span></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></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=\"DeviceDefinition1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>DeviceDefinition</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/devicedefinition.html\">DeviceDefinition</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-DeviceModel.html\">Device Model</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>\n</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>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
      },
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
          "valueCode" : "oo"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
          "valueInteger" : 2,
          "_valueInteger" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"
              }
            ]
          }
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
          "valueCode" : "trial-use",
          "_valueCode" : {
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
                "valueCanonical" : "http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"
              }
            ]
          }
        }
      ],
      "url" : "http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-device-custodian",
      "identifier" : [
        {
          "system" : "urn:ietf:rfc:3986",
          "value" : "urn:oid:2.16.840.1.113883.4.642.40.55.13.1"
        }
      ],
      "version" : "1.0.0",
      "name" : "CapabilityStatement4DeviceCustodian",
      "title" : "CapabilityStatement for custodian of catalog of medical devices",
      "status" : "active",
      "experimental" : false,
      "date" : "2022-10-21",
      "publisher" : "HL7 International / Orders and Observations",
      "contact" : [
        {
          "telecom" : [
            {
              "system" : "url",
              "value" : "http://www.hl7.org/Special/committees/orders"
            }
          ]
        }
      ],
      "description" : "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. \n\nThe DeviceDefinition Resource is the focal Resource describing a model of device in the catalog.",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
              "code" : "001"
            }
          ]
        }
      ],
      "kind" : "requirements",
      "fhirVersion" : "5.0.0",
      "format" : [
        "xml",
        "json"
      ],
      "implementationGuide" : [
        "http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"
      ],
      "rest" : [
        {
          "mode" : "server",
          "documentation" : "The Custodian of a catalog of medical devices **SHALL**:\n\n1. Support profiles CatalogHeader, DeviceModel defined in this Implementation Guide..\n2.  Implement the RESTful behavior according to the FHIR specification.\n3. Return the following response classes:\n   - (Status 400): invalid parameter\n   - (Status 401/4xx): unauthorized request\n   - (Status 403): insufficient scope\n   - (Status 404): unknown resource\n   - (Status 410): deleted resource.\n4. Support json source formats for all order-catalog interactions.\n5. Identify the order-catalog  profiles supported as part of the FHIR `meta.profile` attribute for each instance.\n6. Support the searchParameters on each profile  individually and in combination.\n\nThe Custodian of a catalog of medical devices **SHOULD**:\n\n1. Support xml source formats for all order-catalog interactions.\n2. support the Catalog profile of the Composition Resource in the core standard\n",
          "security" : {
            "description" : "1. A custodian **SHALL** reject any unauthorized requests by returning an HTTP 401 \"Unauthorized\", HTTP 403 \"Forbidden\", or HTTP 404 \"Not Found\" ."
          },
          "resource" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "type" : "DeviceDefinition",
              "supportedProfile" : [
                🔗 "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DeviceModel"
              ],
              "interaction" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "search-type"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "code" : "read"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHOULD"
                    }
                  ],
                  "code" : "vread"
                }
              ],
              "referencePolicy" : [
                "enforced"
              ],
              "searchInclude" : [
                "iterate=*"
              ],
              "searchParam" : [
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "_id",
                  "type" : "token",
                  "documentation" : "http://hl7.org/fhir/2022Sep/search.html#id"
                },
                {
                  "extension" : [
                    {
                      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                      "valueCode" : "SHALL"
                    }
                  ],
                  "name" : "_lastUpdated",
                  "type" : "date",
                  "documentation" : "http://hl7.org/fhir/2022Sep/search.html#lastUpdated"
                }
              ]
            }
          ]
        }
      ]
    }