Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v2.0.0-ballot: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 1.0.0. For a full list of available versions, see the Directory of published versions

OperationDefinition: CRMI Publish Operation

Official URL: http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-publish Version: 2.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: CRMIPublish
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.33.20

The 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.

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