Canonical Resource Management Infrastructure Implementation Guide
1.0.0-snapshot - Snapshot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-snapshot: STU1 Draft) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

: CRMI Approve Operation - JSON Representation

Draft as of 2023-03-12

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "crmi-approve",
  "text" : {
    "status" : "extensions",
    "div" : "<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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</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>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-approve",
  "version" : "1.0.0-snapshot",
  "name" : "CRMIApprove",
  "title" : "CRMI Approve",
  "status" : "draft",
  "kind" : "operation",
  "experimental" : false,
  "date" : "2023-03-12",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "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" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "approve",
  "comment" : "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" : [
    "Resource"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "id",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "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" : "string"
    },
    {
      "name" : "approvalDate",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The date on which the artifact was approved. If one is not provided the system date will be used.",
      "type" : "date"
    },
    {
      "name" : "artifactAssessmentType",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If a comment is submitted as part of the approval, this parameter denotes the type of artifact comment.",
      "type" : "code"
    },
    {
      "name" : "artifactAssessmentSummary",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The body of the comment.",
      "type" : "string"
    },
    {
      "name" : "artifactAssessmentTarget",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The canonical url for the artifact being approved. The format is: [system]|[version] - e.g. http://loinc.org|2.56",
      "type" : "canonical"
    },
    {
      "name" : "artifactAssessmentRelatedArtifact",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional supporting canonical URL / Reference for the comment.",
      "type" : "uri"
    },
    {
      "name" : "artifactAssessmentAuthor",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A Reference to a resource containing information about the entity applying the approval.",
      "type" : "Reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The Bundle result containing both the updated artifact and the ArtifactAssessment resource containing the Approval metadata",
      "type" : "Bundle"
    }
  ]
}