Order Catalog Implementation Guide
1.0.0-ballot - CI Build
Order Catalog Implementation Guide
1.0.0-ballot - CI Build
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
| Page standards status: Trial-use | Maturity Level: 2 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:CapabilityStatement ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "cs-device-custodian"] ; #
fhir:text [
fhir:status [ fhir:v "extensions" ] ;
fhir: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><a name=\"cs-device-custodian-en-US\"> </a><h2 id=\"title\">CapabilityStatement for custodian of catalog of medical devices</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-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 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" .</li>\n</ol>\n</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=\"#DeviceDefinition1-1\">DeviceDefinition</a></td><td>Supported Profiles<br/> <a href=\"StructureDefinition-DeviceModel.html\">Device Model</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=\"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\"> </div></div></div></div></div></div>"^^rdf:XMLLiteral
] ; #
fhir:extension ( [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "oo" ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ] ;
fhir:value [
a fhir:integer ;
fhir:v 2 ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
a fhir:canonical ;
fhir:v "http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog> ] ] ) ]
] [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "trial-use" ;
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom"^^xsd:anyURI ] ;
fhir:value [
a fhir:canonical ;
fhir:v "http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog> ] ] ) ]
] ) ; #
fhir:url [ fhir:v "http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-device-custodian"^^xsd:anyURI] ; #
fhir:identifier ( [
fhir:system [ fhir:v "urn:ietf:rfc:3986"^^xsd:anyURI ] ;
fhir:value [ fhir:v "urn:oid:2.16.840.1.113883.4.642.40.999.13.1" ]
] ) ; #
fhir:version [ fhir:v "1.0.0-ballot"] ; #
fhir:name [ fhir:v "CapabilityStatement4DeviceCustodian"] ; #
fhir:title [ fhir:v "CapabilityStatement for custodian of catalog of medical devices"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:experimental [ fhir:v false] ; #
fhir:date [ fhir:v "2022-10-21"^^xsd:date] ; #
fhir:publisher [ fhir:v "HL7 International / Orders and Observations"] ; #
fhir:contact ( [
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://www.hl7.org/Special/committees/orders" ] ] )
] ) ; #
fhir:description [ fhir:v "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."] ; #
fhir:jurisdiction ( [
( fhir:coding [
fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ] ;
fhir:code [ fhir:v "001" ] ] )
] ) ; #
fhir:kind [ fhir:v "requirements"] ; #
fhir:fhirVersion [ fhir:v "5.0.0"] ; #
fhir:format ( [ fhir:v "xml"] [ fhir:v "json"] ) ; #
fhir:implementationGuide ( [
fhir:v "http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog>
] ) ; #
fhir:rest ( [
fhir:mode [ fhir:v "server" ] ;
fhir:documentation [ fhir:v "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" ] ;
fhir:security [
fhir:description [ fhir:v "1. A custodian **SHALL** reject any unauthorized requests by returning an HTTP 401 \"Unauthorized\", HTTP 403 \"Forbidden\", or HTTP 404 \"Not Found\" ." ] ] ;
( fhir:resource [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "SHALL" ] ] ) ;
fhir:type [ fhir:v "DeviceDefinition" ] ;
( fhir:supportedProfile [
fhir:v "http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DeviceModel"^^xsd:anyURI ;
fhir:link <http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DeviceModel> ] ) ;
( fhir:interaction [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "SHALL" ] ] ) ;
fhir:code [ fhir:v "search-type" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "SHALL" ] ] ) ;
fhir:code [ fhir:v "read" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "SHOULD" ] ] ) ;
fhir:code [ fhir:v "vread" ] ] ) ;
( fhir:referencePolicy [ fhir:v "enforced" ] ) ;
( fhir:searchInclude [ fhir:v "iterate=*" ] ) ;
( fhir:searchParam [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "_id" ] ;
fhir:type [ fhir:v "token" ] ;
fhir:documentation [ fhir:v "http://hl7.org/fhir/2022Sep/search.html#id" ] ] [
( fhir:extension [
fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ] ;
fhir:value [
a fhir:code ;
fhir:v "SHALL" ] ] ) ;
fhir:name [ fhir:v "_lastUpdated" ] ;
fhir:type [ fhir:v "date" ] ;
fhir:documentation [ fhir:v "http://hl7.org/fhir/2022Sep/search.html#lastUpdated" ] ] ) ] )
] ) . #
IG © 2021+ HL7 International / Orders and Observations. Package hl7.fhir.uv.order-catalog#1.0.0-ballot based on FHIR 5.0.0. Generated 2025-06-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change