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 - JSON Representation

Active as of 2022-10-21

Raw json | Download


{
  "resourceType" : "CapabilityStatement",
  "id" : "cs-device-custodian",
  "text" : {
    "status" : "extensions",
    "div" : "<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>\n<p>The DeviceDefinition Resource is the focal Resource describing a model of device in the catalog.</p>\n</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>\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></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/>\u00a0\u00a0<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>"
  },
  "url" : "http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-device-custodian",
  "version" : "current",
  "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 Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://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-ballot",
  "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"
            }
          ]
        }
      ]
    }
  ]
}