FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/crmi-publish

Packagehl7.fhir.uv.crmi
Resource TypeOperationDefinition
Idcrmi-publish
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/crmi/https://build.fhir.org/ig/HL7/crmi-ig/OperationDefinition-crmi-publish.html
URLhttp://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-publish
Version2.0.0-ballot
Statusactive
Date2025-08-01T16:38:28+00:00
NameCRMIPublish
TitleCRMI Publish Operation
Realmuv
Authorityhl7
DescriptionThe CRMI publish operation processes a publishable bundle containing knowledge artifacts and their metadata. This operation is based on the core FHIR Bundle operation but requires that the input Bundle conforms to the CRMIPublishableBundle profile. The bundle must be of type 'transaction' and must contain an ImplementationGuide resource as the first entry. The operation enables atomic publication of related knowledge artifacts (such as Libraries, ActivityDefinitions, PlanDefinitions, Measures, etc.) along with their governing ImplementationGuide, ensuring consistent deployment and proper metadata management.
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition crmi-publish

URL: [base]/$publish

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INbundle1..1Bundle (CRMI Publishable Bundle)

The publishable bundle to be processed. The bundle must conform to the CRMIPublishableBundle profile, meaning:

  • Bundle type must be 'transaction'
  • First entry must contain an ImplementationGuide resource
  • All entries must have proper transaction request information

The bundle contains all related knowledge artifacts that should be published as an atomic unit.

OUTreturn1..1Bundle

The bundle transaction response containing the results of processing each entry in the input bundle.

Each entry in the response bundle corresponds to an entry in the input bundle and contains:

  • The HTTP status code for the transaction
  • The location of the created/updated resource (if successful)
  • Any operation outcomes or error messages

The response follows the same structure as the core FHIR Bundle transaction response.

The CRMI publish operation processes knowledge artifact bundles atomically, ensuring that all resources in the bundle are published together or the entire operation fails. This maintains the integrity of knowledge artifact packages and their dependencies.

The operation validates that:

  1. The bundle conforms to CRMIPublishableBundle profile
  2. The first entry contains an ImplementationGuide
  3. All bundle entries have proper transaction requests
  4. Referenced resources within the bundle are consistent

Source

{
  "resourceType": "OperationDefinition",
  "id": "crmi-publish",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "cds"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 4,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/crmi/ImplementationGuide/hl7.fhir.uv.crmi"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-publish",
  "version": "2.0.0-ballot",
  "name": "CRMIPublish",
  "title": "CRMI Publish Operation",
  "status": "active",
  "kind": "operation",
  "date": "2025-08-01T16:38:28+00:00",
  "publisher": "HL7 International / Clinical Decision Support",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description": "The CRMI publish operation processes a publishable bundle containing knowledge\nartifacts and their metadata.\n\nThis operation is based on the core FHIR Bundle operation but requires that the\ninput Bundle conforms to the CRMIPublishableBundle profile. The bundle must be\nof type 'transaction' and must contain an ImplementationGuide resource as the\nfirst entry.\n\nThe operation enables atomic publication of related knowledge artifacts (such as\nLibraries, ActivityDefinitions, PlanDefinitions, Measures, etc.) along with\ntheir governing ImplementationGuide, ensuring consistent deployment and proper\nmetadata management.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "affectsState": true,
  "code": "publish",
  "comment": "The CRMI publish operation processes knowledge artifact bundles atomically,\nensuring that all resources in the bundle are published together or the entire\noperation fails. This maintains the integrity of knowledge artifact packages and\ntheir dependencies.\n\nThe operation validates that:\n1. The bundle conforms to CRMIPublishableBundle profile\n2. The first entry contains an ImplementationGuide\n3. All bundle entries have proper transaction requests\n4. Referenced resources within the bundle are consistent\n",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "name": "bundle",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The publishable bundle to be processed. The bundle must conform to the CRMIPublishableBundle profile, meaning:\n- Bundle type must be 'transaction'\n- First entry must contain an ImplementationGuide resource\n- All entries must have proper transaction request information\n\nThe bundle contains all related knowledge artifacts that should be published as an atomic unit.",
      "type": "Bundle",
      "targetProfile": [
        "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishable-bundle"
      ]
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The bundle transaction response containing the results of processing each entry in the input bundle.\n\nEach entry in the response bundle corresponds to an entry in the input bundle and contains:\n- The HTTP status code for the transaction\n- The location of the created/updated resource (if successful)\n- Any operation outcomes or error messages\n\nThe response follows the same structure as the core FHIR Bundle transaction response.",
      "type": "Bundle"
    }
  ]
}