Canonical Resource Management Infrastructure Implementation Guide
1.0.0 - STU1

Publication Build: This will be filled in by the publication tooling

## : CRMI Approve Operation - XML Representation

Active as of 2024-05-31

Raw xml | Download

    <OperationDefinition xmlns="http://hl7.org/fhir">
      <id value="crmi-approve"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p>URL: [base]/ActivityDefinition/$approve</p><p>URL: [base]/ActivityDefinition/[id]/$approve</p><p>URL: [base]/CapabilityStatement/$approve</p><p>URL: [base]/CapabilityStatement/[id]/$approve</p><p>URL: [base]/CodeSystem/$approve</p><p>URL: [base]/CodeSystem/[id]/$approve</p><p>URL: [base]/CompartmentDefinition/$approve</p><p>URL: [base]/CompartmentDefinition/[id]/$approve</p><p>URL: [base]/ConceptMap/$approve</p><p>URL: [base]/ConceptMap/[id]/$approve</p><p>URL: [base]/ExampleScenario/$approve</p><p>URL: [base]/ExampleScenario/[id]/$approve</p><p>URL: [base]/GraphDefinition/$approve</p><p>URL: [base]/GraphDefinition/[id]/$approve</p><p>URL: [base]/ImplementationGuide/$approve</p><p>URL: [base]/ImplementationGuide/[id]/$approve</p><p>URL: [base]/Library/$approve</p><p>URL: [base]/Library/[id]/$approve</p><p>URL: [base]/Measure/$approve</p><p>URL: [base]/Measure/[id]/$approve</p><p>URL: [base]/Medication/$approve</p><p>URL: [base]/Medication/[id]/$approve</p><p>URL: [base]/MedicationKnowledge/$approve</p><p>URL: [base]/MedicationKnowledge/[id]/$approve</p><p>URL: [base]/MessageDefinition/$approve</p><p>URL: [base]/MessageDefinition/[id]/$approve</p><p>URL: [base]/NamingSystem/$approve</p><p>URL: [base]/NamingSystem/[id]/$approve</p><p>URL: [base]/OperationDefinition/$approve</p><p>URL: [base]/OperationDefinition/[id]/$approve</p><p>URL: [base]/PlanDefinition/$approve</p><p>URL: [base]/PlanDefinition/[id]/$approve</p><p>URL: [base]/Questionnaire/$approve</p><p>URL: [base]/Questionnaire/[id]/$approve</p><p>URL: [base]/SearchParameter/$approve</p><p>URL: [base]/SearchParameter/[id]/$approve</p><p>URL: [base]/StructureDefinition/$approve</p><p>URL: [base]/StructureDefinition/[id]/$approve</p><p>URL: [base]/StructureMap/$approve</p><p>URL: [base]/StructureMap/[id]/$approve</p><p>URL: [base]/Substance/$approve</p><p>URL: [base]/Substance/[id]/$approve</p><p>URL: [base]/TerminologyCapabilities/$approve</p><p>URL: [base]/TerminologyCapabilities/[id]/$approve</p><p>URL: [base]/TestScript/$approve</p><p>URL: [base]/TestScript/[id]/$approve</p><p>URL: [base]/ValueSet/$approve</p><p>URL: [base]/ValueSet/[id]/$approve</p><p>Parameters</p><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The logical id of the artifact to approved. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)</p>
    </div></td></tr><tr><td>IN</td><td>approvalDate</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#date">date</a></td><td/><td><div><p>The date on which the artifact was approved. If one is not provided the system date will be used.</p>
    </div></td></tr><tr><td>IN</td><td>artifactAssessmentType</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#code">code</a></td><td/><td><div><p>If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment.</p>
    </div></td></tr><tr><td>IN</td><td>artifactAssessmentSummary</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The body of the comment.</p>
    </div></td></tr><tr><td>IN</td><td>artifactAssessmentTarget</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56</p>
    </div></td></tr><tr><td>IN</td><td>artifactAssessmentRelatedArtifact</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#uri">uri</a></td><td/><td><div><p>Optional supporting canonical URL / Reference for the comment.</p>
    </div></td></tr><tr><td>IN</td><td>artifactAssessmentAuthor</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/references.html#Reference">Reference</a></td><td/><td><div><p>A Reference to a resource containing information about the entity applying the approval.</p>
    </div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the Approval metadata</p>
    </div></td></tr></table><div><p>The approve operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying an approval. The artifact assessments which are added by the operation must reference a version of the artifact.</p>
    </div></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="cds"/>
      </extension>
      <url value="http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve"/>
      <version value="1.0.0"/>
      <name value="CRMIApprove"/>
      <title value="CRMI Approve"/>
      <status value="active"/>
      <kind value="operation"/>
      <experimental value="false"/>
      <date value="2024-05-31T16:42:56+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="The approve operation supports applying an approval to an existing artifact, regardless of status. The operation sets the _date_ and _approvalDate_ elements of the approved artifact, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extensions in R4) resources in the repository."/>
      <jurisdiction>
        <coding>
          <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
          <code value="001"/>
          <display value="World"/>
        </coding>
      </jurisdiction>
      <code value="approve"/>
      <comment
               value="The approve operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying an approval. The artifact assessments which are added by the operation must reference a version of the artifact."/>
      <resource value="ActivityDefinition"/>
      <resource value="CapabilityStatement"/>
      <resource value="CodeSystem"/>
      <resource value="CompartmentDefinition"/>
      <resource value="ConceptMap"/>
      <resource value="ExampleScenario"/>
      <resource value="GraphDefinition"/>
      <resource value="ImplementationGuide"/>
      <resource value="Library"/>
      <resource value="Measure"/>
      <resource value="Medication"/>
      <resource value="MedicationKnowledge"/>
      <resource value="MessageDefinition"/>
      <resource value="NamingSystem"/>
      <resource value="OperationDefinition"/>
      <resource value="PlanDefinition"/>
      <resource value="Questionnaire"/>
      <resource value="SearchParameter"/>
      <resource value="StructureDefinition"/>
      <resource value="StructureMap"/>
      <resource value="Substance"/>
      <resource value="TerminologyCapabilities"/>
      <resource value="TestScript"/>
      <resource value="ValueSet"/>
      <system value="false"/>
      <type value="true"/>
      <instance value="true"/>
      <parameter>
        <name value="id"/>
        <use value="in"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The logical id of the artifact to approved. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)"/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="approvalDate"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="The date on which the artifact was approved. If one is not provided the system date will be used."/>
        <type value="date"/>
      </parameter>
      <parameter>
        <name value="artifactAssessmentType"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment."/>
        <type value="code"/>
      </parameter>
      <parameter>
        <name value="artifactAssessmentSummary"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation value="The body of the comment."/>
        <type value="string"/>
      </parameter>
      <parameter>
        <name value="artifactAssessmentTarget"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56"/>
        <type value="canonical"/>
      </parameter>
      <parameter>
        <name value="artifactAssessmentRelatedArtifact"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="Optional supporting canonical URL / Reference for the comment."/>
        <type value="uri"/>
      </parameter>
      <parameter>
        <name value="artifactAssessmentAuthor"/>
        <use value="in"/>
        <min value="0"/>
        <max value="1"/>
        <documentation
                       value="A Reference to a resource containing information about the entity applying the approval."/>
        <type value="Reference"/>
      </parameter>
      <parameter>
        <name value="return"/>
        <use value="out"/>
        <min value="1"/>
        <max value="1"/>
        <documentation
                       value="The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the Approval metadata"/>
        <type value="Bundle"/>
      </parameter>
    </OperationDefinition>