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 Draft Operation - JSON Representation

Active as of 2024-08-29

Raw json | Download


{
  "resourceType" : "OperationDefinition",
  "id" : "crmi-draft",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition crmi-draft</b></p><a name=\"crmi-draft\"> </a><a name=\"hccrmi-draft\"> </a><a name=\"crmi-draft-en-US\"> </a><p>URL: [base]/ActivityDefinition/$draft</p><p>URL: [base]/ActivityDefinition/[id]/$draft</p><p>URL: [base]/CapabilityStatement/$draft</p><p>URL: [base]/CapabilityStatement/[id]/$draft</p><p>URL: [base]/CodeSystem/$draft</p><p>URL: [base]/CodeSystem/[id]/$draft</p><p>URL: [base]/CompartmentDefinition/$draft</p><p>URL: [base]/CompartmentDefinition/[id]/$draft</p><p>URL: [base]/ConceptMap/$draft</p><p>URL: [base]/ConceptMap/[id]/$draft</p><p>URL: [base]/ExampleScenario/$draft</p><p>URL: [base]/ExampleScenario/[id]/$draft</p><p>URL: [base]/GraphDefinition/$draft</p><p>URL: [base]/GraphDefinition/[id]/$draft</p><p>URL: [base]/ImplementationGuide/$draft</p><p>URL: [base]/ImplementationGuide/[id]/$draft</p><p>URL: [base]/Library/$draft</p><p>URL: [base]/Library/[id]/$draft</p><p>URL: [base]/Measure/$draft</p><p>URL: [base]/Measure/[id]/$draft</p><p>URL: [base]/Medication/$draft</p><p>URL: [base]/Medication/[id]/$draft</p><p>URL: [base]/MedicationKnowledge/$draft</p><p>URL: [base]/MedicationKnowledge/[id]/$draft</p><p>URL: [base]/MessageDefinition/$draft</p><p>URL: [base]/MessageDefinition/[id]/$draft</p><p>URL: [base]/NamingSystem/$draft</p><p>URL: [base]/NamingSystem/[id]/$draft</p><p>URL: [base]/OperationDefinition/$draft</p><p>URL: [base]/OperationDefinition/[id]/$draft</p><p>URL: [base]/PlanDefinition/$draft</p><p>URL: [base]/PlanDefinition/[id]/$draft</p><p>URL: [base]/Questionnaire/$draft</p><p>URL: [base]/Questionnaire/[id]/$draft</p><p>URL: [base]/SearchParameter/$draft</p><p>URL: [base]/SearchParameter/[id]/$draft</p><p>URL: [base]/StructureDefinition/$draft</p><p>URL: [base]/StructureDefinition/[id]/$draft</p><p>URL: [base]/StructureMap/$draft</p><p>URL: [base]/StructureMap/[id]/$draft</p><p>URL: [base]/Substance/$draft</p><p>URL: [base]/Substance/[id]/$draft</p><p>URL: [base]/TerminologyCapabilities/$draft</p><p>URL: [base]/TerminologyCapabilities/[id]/$draft</p><p>URL: [base]/TestScript/$draft</p><p>URL: [base]/TestScript/[id]/$draft</p><p>URL: [base]/ValueSet/$draft</p><p>URL: [base]/ValueSet/[id]/$draft</p><h3>Parameters</h3><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>0..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 draft. The server must know the artifact (e.g. it is defined explicitly in the server's resources)</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>A semantic version in the form MAJOR.MINOR.PATCH.REVISION</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 the new resource(s)</p>\n</div></td></tr></table><div><p>This operation is used to set the status and version. It also removes effectivePeriod, approvalDate and any extensions which are only valid for active artifacts.</p>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-draft",
  "version" : "1.1.0-cibuild",
  "name" : "CRMIDraft",
  "title" : "CRMI Draft",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-08-29T03:38:40+00:00",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "Creates a draft version of a knowledge artifact, as well as for all resources it is composed of.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "draft",
  "comment" : "This operation is used to set the status and version. It also removes effectivePeriod, approvalDate and any extensions which are only valid for active artifacts.",
  "resource" : [
    "ActivityDefinition",
    "CapabilityStatement",
    "CodeSystem",
    "CompartmentDefinition",
    "ConceptMap",
    "ExampleScenario",
    "GraphDefinition",
    "ImplementationGuide",
    "Library",
    "Measure",
    "Medication",
    "MedicationKnowledge",
    "MessageDefinition",
    "NamingSystem",
    "OperationDefinition",
    "PlanDefinition",
    "Questionnaire",
    "SearchParameter",
    "StructureDefinition",
    "StructureMap",
    "Substance",
    "TerminologyCapabilities",
    "TestScript",
    "ValueSet"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "id",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The logical id of the artifact to draft. The server must know the artifact (e.g. it is defined explicitly in the server's resources)",
      "type" : "string"
    },
    {
      "name" : "version",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "A semantic version in the form MAJOR.MINOR.PATCH.REVISION",
      "type" : "string"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The Bundle result containing the new resource(s)",
      "type" : "Bundle"
    }
  ]
}