This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot2: STU1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
: CRMI Approve Operation - XML Representation
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]/Resource/$approve</p><p>URL: [base]/Resource/[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 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 resource by applying an approval. The ArtifactAssessments 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-ballot2"/>
<name value="CRMIApprove"/>
<title value="CRMI Approve"/>
<status value="draft"/>
<kind value="operation"/>
<experimental value="false"/>
<date value="2023-03-12"/>
<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 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 resource by applying an approval. The ArtifactAssessments which are added by the operation must reference a version of the artifact."/>
<resource value="Resource"/>
<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 resource containing the Approval metadata"/>
<type value="Bundle"/>
</parameter>
</OperationDefinition>
|
Propose a change