FHIR IG Statistics: OperationDefinition/crmi-package

Resources that use this resource

Resources that this resource uses

No resources found

Narrative

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

Source

{
  "resourceType": "OperationDefinition",
  "id": "crmi-package",
  "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-package",
  "version": "2.0.0-ballot",
  "name": "CRMIPackage",
  "title": "CRMI Package",
  "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": "Packages a specified canonical resource for use in a target environment, optionally \nincluding related content such as dependencies, components, and test cases and data.\n\nSee [$package and $data-requirements](distribution.html#package-and-data-requirements)",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "code": "package",
  "comment": "The package operation supports producing a complete package of a particular artifact \nsupporting the capabilities expected to be available in a particular target environment. \nFor example, a Questionnaire may be packaged together with the value sets referenced by \nelements of the questionnaire, and those value sets may be definitions (Computable) or \nexpansions (Expanded), depending on the parameters to the operation. ",
  "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 an existing Resource to package on the server.",
      "type": "string"
    },
    {
      "name": "url",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A canonical or artifact reference to a Resource to package on the server.",
      "type": "uri"
    },
    {
      "name": "version",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The version of the Resource",
      "type": "string"
    },
    {
      "name": "identifier",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A business identifier of the Resource.",
      "type": "string",
      "searchType": "token"
    },
    {
      "name": "capability",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "A desired capability of the resulting package. `computable` to include\ncomputable elements in packaged content; `executable` to include executable\nelements in packaged content; `publishable` to include publishable elements in\npackaged content.\n\nIf no capabilities are specified, the capabilities of resulting artifacts in the package are decided by the server.\nIf a server has been requested to produce an executable package, and for whatever reason, cannot expand a value set \nthat is part of the package, it SHALL include an operation outcome warning detailed the value sets that could not be\nexpanded, as described in the [Outcome Manifest](distribution.html#outcome-manifest) topic.\n\nIn addition, so long as the errorBehavior parameter is not `strict`, the server MAY include a computable representation of\nvalue sets that could not be expanded.",
      "type": "string"
    },
    {
      "name": "terminologyCapabilities",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A TerminologyCapabilities resource describing the expected terminology capabilities \nof the target environment. For example, an environment may be capable of processing \nspecific types of value set definitions, but not others (e.g. LOINC panel definitions, \nbut not SNOMED hierarchies).",
      "type": "TerminologyCapabilities"
    },
    {
      "name": "artifactVersion",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies a version to use for a canonical or artifact resource if the artifact referencing \nthe resource does not already specify a version. The format is the same as a canonical URL:\n[url]|[version] - e.g. http://loinc.org|2.56 Note that this is a generalization of the `system-version`\nparameter to the $expand operation to apply to any canonical resource, including code systems.",
      "type": "uri"
    },
    {
      "name": "checkArtifactVersion",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a canonical or artifact resource. If the artifact referencing \nthe resource specifies a different version, an error is returned instead of the package. The\nformat is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56 Note that\nthis is a generalization of the `check-system-version` parameter to the $expand operation to \napply to any canonical resource, including code systems.",
      "type": "uri"
    },
    {
      "name": "forceArtifactVersion",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Edge Case: Specifies a version to use for a canonical or artifact resource. This parameter overrides any\nspecified version in the artifact (and any artifacts it depends on). The\nformat is the same as a canonical URL: [system]|[version] - e.g.\nhttp://loinc.org|2.56. Note that this has obvious safety issues, in that it may\nresult in a value set expansion giving a different list of codes that is both\nwrong and unsafe, and implementers should only use this capability reluctantly.\nIt primarily exists to deal with situations where specifications have fallen\ninto decay as time passes. If the version of a canonical is overridden, the version used SHALL\nexplicitly be represented in the expansion parameters. Note that this is a generalization of the\n`force-system-version` parameter to the $expand operation to apply to any canonical resource,\nincluding code systems.",
      "type": "uri"
    },
    {
      "name": "manifest",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Specifies a reference to an asset-collection library that defines version\nbindings for code systems and other canonical resources referenced by the value\nset(s) being expanded and other canonical resources referenced by the artifact.\nWhen specified, code systems and other canonical resources identified as\n`depends-on` related artifacts in the manifest library have the same meaning as\nspecifying that code system or other canonical version in the `system-version`\nparameter of an expand or the `canonicalVersion` parameter.",
      "type": "canonical",
      "targetProfile": [
        "http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-manifestlibrary"
      ]
    },
    {
      "name": "offset",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Paging support - where to start if a subset is desired (default = 0). Offset is\nnumber of records (not number of pages). If offset > 0 the resulting bundle will be of type `collection`.",
      "type": "integer"
    },
    {
      "name": "count",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Paging support - how many resources should be provided in a partial page view.\nIf count = 0, the client is asking how large the package is. If count > 0 but less than the total number of resources, the result will be a bundle of type `collection`.",
      "type": "integer"
    },
    {
      "name": "include",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies what contents should only be included in the resulting package. The\ncodes indicate which types of resources should be included, but note that the\nset of possible resources is determined as all known (i.e. present on the\nserver) dependencies and related artifacts. \n\nPossible values are either a code to mean a category of resource types:\n* `all` (default) - all resource types\n* `artifact` - the specified artifact\n* `canonical` - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)\n* `terminology` - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)\n* `conformance` - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)\n* `profiles` - profile definitions (i.e. StructureDefinition resources that define profiles)\n* `extensions` - extension definitions (i.e. StructureDefinition resources that define extensions) \n* `knowledge` - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)\n* `tests` - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)\n* `examples` - example resources (i.e. resources identified as examples in the implementation guide)\n\nOr a valid FHIR resource Type (e.g. `PlanDefinition`, `MedicationKnowledge`, etc)",
      "type": "code"
    },
    {
      "name": "includeUri",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies what contents should be included in the resulting package by canonical\nURL, can take the form `{url}` or `{url}|{version}`.",
      "type": "uri"
    },
    {
      "name": "exclude",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies what contents should be excluded in the resulting package. The codes\nindicate which types of resources should be excluded, but note that the set of\npossible resources is determined as all known (i.e. present on the server)\ndependencies and related artifacts. \n\nPossible values are either a code to mean a category of resource types:\n* `all` (default) - all resource types\n* `artifact` - the specified artifact\n* `canonical` - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)\n* `terminology` - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)\n* `conformance` - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)\n* `profiles` - profile definitions (i.e. StructureDefinition resources that define profiles)\n* `extensions` - extension definitions (i.e. StructureDefinition resources that define extensions) \n* `knowledge` - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)\n* `tests` - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)\n* `examples` - example resources (i.e. resources identified as examples in the implementation guide)\n\nOr a valid FHIR resource Type (e.g. `PlanDefinition`, `MedicationKnowledge`, etc)",
      "type": "code"
    },
    {
      "name": "excludeUri",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Specifies what contents should be excluded in the resulting package by canonical\nURL, can take the form `{url}` or `{url}|{version}`.",
      "type": "uri"
    },
    {
      "name": "packageOnly",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "True to indicate that the resulting package should only include resources that are defined in the implementation guide \nor specification that defines the artifact being packaged. False (default) to indicate that the resulting package should \ninclude resources regardless of what implementation guide or specification they are defined in.",
      "type": "boolean"
    },
    {
      "name": "errorBehavior",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "A code that determines whether issues encountered during the packaging should prevent the return of the package, or should\njust be included in the resulting package with a description of the issues. A code of `loose` indicates that the server \nshould continue processing and return any issues such as \"resource not found\" and \"could not expand value set\" as issues in\nthe messages element of the resulting outcome manifest, whereas a code of `strict` indicates that if the server cannot '\nprovide the package that was requested, an error should be returned. (i.e. the result of the operation will be an OperationOutcome\nresource describing the issues that occurred, as opposed to the OperationOutcome being included in the result). Note that servers\nmay still decide what constitutes an error severe enough to stop processing, this error behavior parameter is an indication from the\nclient that they want as much of the package as the server can provide, and will examine the messages to determine where the package \ndiffers from what was requested.",
      "type": "code"
    },
    {
      "name": "artifactEndpointConfiguration",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Configuration information to resolve canonical artifacts\n* `artifactRoute`: An optional route used to determine whether this endpoint is expected to be able to resolve artifacts that match the route (i.e. start with the route, up to and including the entire url)\n* `endpointUri`: The URI of the endpoint, exclusive with the `endpoint` parameter\n* `endpoint`: An Endpoint resource describing the endpoint, exclusive with the `endpointUri` parameter\n\n**Processing semantics**:\n\nCreate a canonical-like reference (e.g.\n`{canonical.url}|{canonical.version}` or similar extensions for non-canonical artifacts).\n\n* Given a single `artifactEndpointConfiguration`\n  * When `artifactRoute` is present\n    * And `artifactRoute` *starts with* canonical or artifact reference\n    * Then attempt to resolve with `endpointUri` or `endpoint`\n  * When `artifactRoute` is not present\n    * Then attempt to resolve with `endpointUri` or `endpoint`\n* Given multiple `artifactEndpointConfiguration`s\n  * Then rank order each configuration (see below)\n  * And attempt to resolve with `endpointUri` or `endpoint` in order until resolved\n\nRank each `artifactEndpointConfiguration` such that:\n* if `artifactRoute` is present *and* `artifactRoute` *starts with* canonical or artifact reference: rank based on number of matching characters \n* if `artifactRoute` is *not* present: include but rank lower\n\nNOTE: For evenly ranked `artifactEndpointConfiguration`s, order as defined in the\nOperationDefinition.",
      "part": [
        {
          "name": "artifactRoute",
          "use": "in",
          "min": 0,
          "max": "1",
          "type": "uri"
        },
        {
          "name": "endpointUri",
          "use": "in",
          "min": 0,
          "max": "1",
          "type": "uri"
        },
        {
          "name": "endpoint",
          "use": "in",
          "min": 0,
          "max": "1",
          "type": "Endpoint"
        }
      ]
    },
    {
      "name": "terminologyEndpoint",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and\nmembership testing) referenced by the Resource. If no terminology endpoint is\nsupplied, the server may use whatever mechanism is appropriate for accessing terminology. \nThis could be the server on which the operation is invoked or a third party server accessible to the environment. \nWhen a terminology endpoint is provided, the server or third party servers may still be used as fallbacks.",
      "type": "Endpoint"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The result of the packaging. If the resulting bundle is paged using `count` or `offset`, it will be of type `collection`. In the special case where `count = 0` it will be of type `searchset`.\n\nThe first resource returned in the resulting package will be an [_outcome manifest_](distribution.html#outcome-manifest) \nthat describes the results of the packaging operation. Clients consuming package bundles SHALL examine the contents of \nthese OperationOutcome resources to understand whether the bundle contains the expected content (e.g. if a ValueSet could not be expanded).\n\nServers generating packages SHALL include all the\ndependency resources referenced by the artifact that are known to the server and \nspecified by the include parameters. \n\nFor example, a measure repository SHALL include\nall the required library resources, but would not necessarily have the\nValueSet resources referenced by the measure.",
      "type": "Bundle"
    }
  ]
}