Package | hl7.fhir.uv.order-catalog |
Type | CapabilityStatement |
Id | cs-device-custodian |
FHIR Version | R5 |
Source | http://hl7.org/fhir/uv/order-catalog/https://build.fhir.org/ig/HL7/fhir-order-catalog/CapabilityStatement-cs-device-custodian.html |
URL | http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-device-custodian |
Version | 1.0.0-ballot |
Status | active |
Date | 2022-10-21 |
Name | CapabilityStatement4DeviceCustodian |
Title | CapabilityStatement for custodian of catalog of medical devices |
Realm | uv |
Authority | hl7 |
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. The DeviceDefinition Resource is the focal Resource describing a model of device in the catalog. |
Kind | requirements |
No resources found
StructureDefinition | |
DeviceModel | Device Model |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement cs-device-custodian
xml
, json
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.
server
The Custodian of a catalog of medical devices SHALL:
meta.profile
attribute for each instance.The Custodian of a catalog of medical devices SHOULD:
- A custodian SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" .
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|
DeviceDefinition | Supported Profiles Device Model | y | y | y | _id, _lastUpdated | iterate=* |
enforced
search-type
, read
.vread
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | http://hl7.org/fhir/2022Sep/search.html#id |
SHALL | _lastUpdated | date | http://hl7.org/fhir/2022Sep/search.html#lastUpdated |
{ "resourceType": "CapabilityStatement", "id": "cs-device-custodian", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "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.999.13.1" } ], "version": "1.0.0-ballot", "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" } ] } ] } ] }