Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild International flag

Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

: CRMI Authoring Artifact Repository - XML Representation

Active as of 2024-08-29

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="crmi-authoring-artifact-repository"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement crmi-authoring-artifact-repository</b></p><a name="crmi-authoring-artifact-repository"> </a><a name="hccrmi-authoring-artifact-repository"> </a><a name="crmi-authoring-artifact-repository-en-US"> </a><h2 id="title">CRMI Authoring Artifact Repository</h2><ul><li>Implementation Guide Version: 1.1.0-cibuild </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-08-29 03:38:40+0000 </li><li>Published by: HL7 International / Clinical Decision Support </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><p>This CapabilityStatement imports these CapabilityStatements <a href="CapabilityStatement-crmi-shareable-artifact-repository.html">CRMI Shareable Artifact Repository</a>, <a href="CapabilityStatement-crmi-publishable-artifact-repository.html">CRMI Publishable Artifact Repository</a></p><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li><a href="index.html">http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi</a></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>RESTful Authoring Artifact Repository</p>
</div><div class="lead"><em>Security</em></div><div class="row"><div class="col-lg-6">Enable CORS: yes</div><div class="col-lg-6">Security services supported: <code>Certificates</code></div></div><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 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 class="text-center"><b title="DELETE a resource (delete interaction)">D</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="#ActivityDefinition1-1">ActivityDefinition</a></td><td> </td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Library1-2">Library</a></td><td> </td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#Measure1-3">Measure</a></td><td> </td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#PlanDefinition1-4">PlanDefinition</a></td><td> </td><td class="text-center"></td><td class="text-center"></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="ActivityDefinition1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>ActivityDefinition</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/R4/activitydefinition.html">ActivityDefinition</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Create allows authoring workflows to post new activity definitions in <em>draft</em> (<strong>submit</strong>) or <em>active</em> (<strong>publish</strong>) status.</p>
</div><code>update</code><div><p>Update allows authoring workflows to update existing activity definitions in <em>draft</em> (<strong>revise</strong>) status, add comments to existing activity definitions (<strong>review</strong> and <strong>approve</strong>), and <strong>release</strong> or <strong>retire</strong> an activity definition.</p>
</div><code>delete</code><div><p>Delete allows authoring workflows to <strong>withdraw</strong> <em>draft</em> activity definitions or <strong>archive</strong> <em>retired</em> activity definitions.</p>
</div></li></ul></div></div><p/><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Library1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Library</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/R4/library.html">Library</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Create allows authoring workflows to post new libraries in <em>draft</em> (<strong>submit</strong>) or <em>active</em> (<strong>publish</strong>) status.</p>
</div><code>update</code><div><p>Update allows authoring workflows to update existing libraries in <em>draft</em> (<strong>revise</strong>) status, add comments to existing libraries (<strong>review</strong> and <strong>approve</strong>), and <strong>release</strong> or <strong>retire</strong> a library.</p>
</div><code>delete</code><div><p>Delete allows authoring workflows to <strong>withdraw</strong> <em>draft</em> libraries or <strong>archive</strong> <em>retired</em> libraries.</p>
</div></li></ul></div></div><p/><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Measure1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Measure</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/R4/measure.html">Measure</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Create allows authoring workflows to post new measures in <em>draft</em> (<strong>submit</strong>) or <em>active</em> (<strong>publish</strong>) status.</p>
</div><code>update</code><div><p>Update allows authoring workflows to update existing measures in <em>draft</em> (<strong>revise</strong>) status, add comments to existing measures (<strong>review</strong> and <strong>approve</strong>), and <strong>release</strong> or <strong>retire</strong> a measure.</p>
</div><code>delete</code><div><p>Delete allows authoring workflows to <strong>withdraw</strong> <em>draft</em> measures or <strong>archive</strong> <em>retired</em> measures.</p>
</div></li></ul></div></div><p/><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="PlanDefinition1-4" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>PlanDefinition</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/R4/plandefinition.html">PlanDefinition</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Create allows authoring workflows to post new plan definitions in <em>draft</em> (<strong>submit</strong>) or <em>active</em> (<strong>publish</strong>) status.</p>
</div><code>update</code><div><p>Update allows authoring workflows to update existing plan definitions in <em>draft</em> (<strong>revise</strong>) status, add comments to existing plan definitions (<strong>review</strong> and <strong>approve</strong>), and <strong>release</strong> or <strong>retire</strong> a plan definition.</p>
</div><code>delete</code><div><p>Delete allows authoring workflows to <strong>withdraw</strong> <em>draft</em> plan definitions or <strong>archive</strong> <em>retired</em> plan definitions.</p>
</div></li></ul></div></div><p/><p/></div></div></div><h3 id="operationsCap1">Operations</h3><h4 id="operationsSummary1">Use</h4></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="cds"/>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/crmi/CapabilityStatement/crmi-authoring-artifact-repository"/>
  <version value="1.1.0-cibuild"/>
  <name value="CRMIAuthoringArtifactRepository"/>
  <title value="CRMI Authoring Artifact Repository"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2024-08-29T03:38:40+00:00"/>
  <publisher value="HL7 International / Clinical Decision Support"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/dss"/>
    </telecom>
  </contact>
  <description
               value="Capability statement for a repository service supporting additional authoring and content workflow capabilities for FHIR-based knowledge artifacts above the basic ShareableArtifactRepository."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <imports
           value="http://hl7.org/fhir/uv/crmi/CapabilityStatement/crmi-shareable-artifact-repository"/>
  <imports
           value="http://hl7.org/fhir/uv/crmi/CapabilityStatement/crmi-publishable-artifact-repository"/>
  <fhirVersion value="4.0.1"/>
  <format value="json"/>
  <format value="xml"/>
  <implementationGuide
                       value="http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"/>
  <rest>
    <mode value="server"/>
    <documentation value="RESTful Authoring Artifact Repository"/>
    <security>
      <cors value="true"/>
      <service>
        <coding>
          <system
                  value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
          <code value="Certificates"/>
        </coding>
      </service>
    </security>
    <resource>
      <type value="ActivityDefinition"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="Create allows authoring workflows to post new activity definitions in _draft_ (**submit**) or _active_ (**publish**) status."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="Update allows authoring workflows to update existing activity definitions in _draft_ (**revise**) status, add comments to existing activity definitions (**review** and **approve**), and **release** or **retire** an activity definition."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Delete allows authoring workflows to **withdraw** _draft_ activity definitions or **archive** _retired_ activity definitions."/>
      </interaction>
    </resource>
    <resource>
      <type value="Library"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="Create allows authoring workflows to post new libraries in _draft_ (**submit**) or _active_ (**publish**) status."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="Update allows authoring workflows to update existing libraries in _draft_ (**revise**) status, add comments to existing libraries (**review** and **approve**), and **release** or **retire** a library."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Delete allows authoring workflows to **withdraw** _draft_ libraries or **archive** _retired_ libraries."/>
      </interaction>
    </resource>
    <resource>
      <type value="Measure"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="Create allows authoring workflows to post new measures in _draft_ (**submit**) or _active_ (**publish**) status."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="Update allows authoring workflows to update existing measures in _draft_ (**revise**) status, add comments to existing measures (**review** and **approve**), and **release** or **retire** a measure."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Delete allows authoring workflows to **withdraw** _draft_ measures or **archive** _retired_ measures."/>
      </interaction>
    </resource>
    <resource>
      <type value="PlanDefinition"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="Create allows authoring workflows to post new plan definitions in _draft_ (**submit**) or _active_ (**publish**) status."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="Update allows authoring workflows to update existing plan definitions in _draft_ (**revise**) status, add comments to existing plan definitions (**review** and **approve**), and **release** or **retire** a plan definition."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Delete allows authoring workflows to **withdraw** _draft_ plan definitions or **archive** _retired_ plan definitions."/>
      </interaction>
    </resource>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="approve"/>
      <definition
                  value="http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve"/>
    </operation>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="draft"/>
      <definition
                  value="http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-draft"/>
    </operation>
    <operation>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <name value="release"/>
      <definition
                  value="http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-release"/>
    </operation>
  </rest>
</CapabilityStatement>