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 medication catalog - XML Representation
Raw xml | Download
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="cs-drug-custodian"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2>CapabilityStatement4DrugCustodian</h2><div><p>This Section describes the expected capabilities of the Custodian of a catalog of medications. This role is responsible for providing responses to the queries submitted by the catalog consumers.</p>
<p>The MedicationKnowledge Resource is the focal Resource gathering all knowledge and information details about a medication in the catalog.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td><div><p>The Custodian of a catalog of medications <strong>SHALL</strong>:</p>
<ol>
<li>Support profiles CatalogHeader, DrugKnowledge, DrugPackage defined in this Implementation Guide..</li>
<li>Implement the RESTful behavior according to the FHIR specification.</li>
<li>Return the following response classes:
<ul>
<li>(Status 400): invalid parameter</li>
<li>(Status 401/4xx): unauthorized request</li>
<li>(Status 403): insufficient scope</li>
<li>(Status 404): unknown resource</li>
<li>(Status 410): deleted resource.</li>
</ul>
</li>
<li>Support json source formats for all order-catalog interactions.</li>
<li>Identify the order-catalog profiles supported as part of the FHIR <code>meta.profile</code> attribute for each instance.</li>
<li>Support the searchParameters on each profile individually and in combination.</li>
</ol>
<p>The Custodian of a catalog of medications <strong>SHOULD</strong>:</p>
<ol>
<li>Support xml source formats for all order-catalog interactions.</li>
<li>support the Catalog profile of the Composition Resource in the core standard</li>
</ol>
</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>MedicationKnowledge</td><td>Supported profiles:<br/> <a href="StructureDefinition-DrugKnowledge.html">item in a catalog of drugs</a></td><td>y</td><td>y</td><td>y</td><td></td><td></td></tr></table></div>
</text>
<url
value="http://hl7.org/fhir/uv/order-catalog/CapabilityStatement/cs-drug-custodian"/>
<version value="current"/>
<name value="CapabilityStatement4DrugCustodian"/>
<title value="CapabilityStatement for custodian of catalog of medications"/>
<status value="active"/>
<experimental value="false"/>
<date value="2022-09-16"/>
<publisher value="HL7 International - Orders and Observations Work Group"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/Special/committees/orders"/>
</telecom>
</contact>
<description
value="This Section describes the expected capabilities of the Custodian of a catalog of medications. This role is responsible for providing responses to the queries submitted by the catalog consumers.
The MedicationKnowledge Resource is the focal Resource gathering all knowledge and information details about a medication in the catalog."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="5.0.0-ballot"/>
<format value="xml"/>
<format value="json"/>
<implementationGuide
value="http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog"/>
<rest>
<mode value="server"/>
<documentation
value="The Custodian of a catalog of medications **SHALL**:
1. Support profiles CatalogHeader, DrugKnowledge, DrugPackage 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 medications **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>
<description
value="1. A custodian **SHALL** reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found" ."/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="MedicationKnowledge"/>
<supportedProfile
value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/DrugKnowledge"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
</interaction>
<referencePolicy value="enforced"/>
<searchInclude value="iterate=*"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<type value="token"/>
<documentation value="http://hl7.org/fhir/2022Sep/search.html#id"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<type value="date"/>
<documentation
value="http://hl7.org/fhir/2022Sep/search.html#lastUpdated"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>
|
Propose a change