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

CapabilityStatement: Custodian of medical device catalog

Official URL: http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-device-custodian Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: CapabilityStatement4DeviceCustodian
Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.13.1

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.

Raw OpenAPI-Swagger Definition file | Download

CapabilityStatement for custodian of catalog of medical devices

  • Implementation Guide Version: 1.0.0-ballot
  • FHIR Version: 5.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2022-10-21
  • Published by: HL7 International / Orders and Observations

Note to Implementers: FHIR Capabilities

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.

SHALL Support the Following Implementation Guides

  • http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog

FHIR RESTful Capabilities

Mode: server

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
  1. A custodian SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" .
Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUCSearches_include_revincludeOperations
DeviceDefinitionSupported Profiles
  Device Model		yyy_id, _lastUpdatediterate=*

Resource Conformance: SHALL DeviceDefinition

Core FHIR Resource
DeviceDefinition
Reference Policy
enforced
Interaction summary
  • SHALL support search-type, read.
  • SHOULD support vread.

Supported Profiles

Device Model

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

http://hl7.org/fhir/2022Sep/search.html#id

SHALL_lastUpdateddate

http://hl7.org/fhir/2022Sep/search.html#lastUpdated