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

Active as of 2022-10-21

Raw ttl | Download


@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@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\"><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/>  <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>"
  ] ; # 
  fhir:url [ fhir:v "http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-device-custodian"^^xsd:anyURI] ; # 
  fhir:version [ fhir:v "current"] ; # 
  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"^^xsd:boolean] ; # 
  fhir:date [ fhir:v "2022-10-21"^^xsd:date] ; # 
  fhir:publisher [ fhir:v "HL7 International - Orders and Observations Work Group"] ; # 
  fhir:contact ( [
    ( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "http://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-ballot"] ; # 
  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 [ 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 [ 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 [ 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 [ 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 [ 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 [ 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" ]       ] )     ] )
  ] ) . #