The logical id of an existing Resource to package on the server.

A canonical or artifact reference to a Resource to package on the server.

The version of the Resource

A business identifier of the Resource.

A desired capability of the resulting package. computable to include computable elements in packaged content; executable to include executable elements in packaged content; publishable to include publishable elements in packaged content.

If no capabilities are specified, the capabilities of resulting artifacts in the package are decided by the server. If a server has been requested to produce an executable package, and for whatever reason, cannot expand a value set that is part of the package, it SHALL include an operation outcome warning detailed the value sets that could not be expanded, as described in the Outcome Manifest topic.

In addition, so long as the errorBehavior parameter is not strict, the server MAY include a computable representation of value sets that could not be expanded.

A TerminologyCapabilities resource describing the expected terminology capabilities of the target environment. For example, an environment may be capable of processing specific types of value set definitions, but not others (e.g. LOINC panel definitions, but not SNOMED hierarchies).

Specifies a version to use for a canonical or artifact resource if the artifact referencing the resource does not already specify a version. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56 Note that this is a generalization of the system-version parameter to the $expand operation to apply to any canonical resource, including code systems.

Edge Case: Specifies a version to use for a canonical or artifact resource. If the artifact referencing the resource specifies a different version, an error is returned instead of the package. The format is the same as a canonical URL: [url]|[version] - e.g. http://loinc.org|2.56 Note that this is a generalization of the check-system-version parameter to the $expand operation to apply to any canonical resource, including code systems.

Edge Case: Specifies a version to use for a canonical or artifact resource. This parameter overrides any specified version in the artifact (and any artifacts it depends on). The format is the same as a canonical URL: [system]|[version] - e.g. http://loinc.org|2.56. Note that this has obvious safety issues, in that it may result in a value set expansion giving a different list of codes that is both wrong and unsafe, and implementers should only use this capability reluctantly. It primarily exists to deal with situations where specifications have fallen into decay as time passes. If the version of a canonical is overridden, the version used SHALL explicitly be represented in the expansion parameters. Note that this is a generalization of the force-system-version parameter to the $expand operation to apply to any canonical resource, including code systems.

Specifies a reference to an asset-collection library that defines version bindings for code systems and other canonical resources referenced by the value set(s) being expanded and other canonical resources referenced by the artifact. When specified, code systems and other canonical resources identified as depends-on related artifacts in the manifest library have the same meaning as specifying that code system or other canonical version in the system-version parameter of an expand or the canonicalVersion parameter.

Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages). If offset > 0 the resulting bundle will be of type collection.

Paging support - how many resources should be provided in a partial page view. If 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.

Specifies what contents should only be included in the resulting package. The codes indicate which types of resources should be included, but note that the set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts.

Possible values are either a code to mean a category of resource types:

• all (default) - all resource types
• artifact - the specified artifact
• canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)
• terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)
• conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)
• profiles - profile definitions (i.e. StructureDefinition resources that define profiles)
• extensions - extension definitions (i.e. StructureDefinition resources that define extensions)
• knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)
• tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)
• examples - example resources (i.e. resources identified as examples in the implementation guide)

Or a valid FHIR resource Type (e.g. PlanDefinition, MedicationKnowledge, etc)

Specifies what contents should be included in the resulting package by canonical URL, can take the form {url} or {url}|{version}.

Specifies what contents should be excluded in the resulting package. The codes indicate which types of resources should be excluded, but note that the set of possible resources is determined as all known (i.e. present on the server) dependencies and related artifacts.

Possible values are either a code to mean a category of resource types:

• all (default) - all resource types
• artifact - the specified artifact
• canonical - canonical resources (i.e. resources with a defined url element or that can be canonical resources using the artifact-url extension)
• terminology - terminology resources (i.e. CodeSystem, ValueSet, NamingSystem, ConceptMap)
• conformance - conformance resources (i.e. StructureDefinition, StructureMap, SearchParameter, CompartmentDefinition)
• profiles - profile definitions (i.e. StructureDefinition resources that define profiles)
• extensions - extension definitions (i.e. StructureDefinition resources that define extensions)
• knowledge - knowledge artifacts (i.e. ActivityDefinition, Library, PlanDefinition, Measure, Questionnaire)
• tests - test cases and data (i.e. test cases as defined by the testing specification in this implementation guide)
• examples - example resources (i.e. resources identified as examples in the implementation guide)

Or a valid FHIR resource Type (e.g. PlanDefinition, MedicationKnowledge, etc)

Specifies what contents should be excluded in the resulting package by canonical URL, can take the form {url} or {url}|{version}.

True to indicate that the resulting package should only include resources that are defined in the implementation guide or specification that defines the artifact being packaged. False (default) to indicate that the resulting package should include resources regardless of what implementation guide or specification they are defined in.

A code that determines whether issues encountered during the packaging should prevent the return of the package, or should just be included in the resulting package with a description of the issues. A code of loose indicates that the server should continue processing and return any issues such as "resource not found" and "could not expand value set" as issues in the messages element of the resulting outcome manifest, whereas a code of strict indicates that if the server cannot ' provide the package that was requested, an error should be returned. (i.e. the result of the operation will be an OperationOutcome resource describing the issues that occurred, as opposed to the OperationOutcome being included in the result). Note that servers may still decide what constitutes an error severe enough to stop processing, this error behavior parameter is an indication from the client that they want as much of the package as the server can provide, and will examine the messages to determine where the package differs from what was requested.

Configuration information to resolve canonical artifacts

• 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)
• endpointUri: The URI of the endpoint, exclusive with the endpoint parameter
• endpoint: An Endpoint resource describing the endpoint, exclusive with the endpointUri parameter

Processing semantics:

Create a canonical-like reference (e.g. {canonical.url}|{canonical.version} or similar extensions for non-canonical artifacts).

• Given a single artifactEndpointConfiguration
  • When artifactRoute is present
    • And artifactRoute starts with canonical or artifact reference
    • Then attempt to resolve with endpointUri or endpoint
  • When artifactRoute is not present
    • Then attempt to resolve with endpointUri or endpoint
• Given multiple artifactEndpointConfigurations
  • Then rank order each configuration (see below)
  • And attempt to resolve with endpointUri or endpoint in order until resolved

Rank each artifactEndpointConfiguration such that:

• if artifactRoute is present and artifactRoute starts with canonical or artifact reference: rank based on number of matching characters
• if artifactRoute is not present: include but rank lower

NOTE: For evenly ranked artifactEndpointConfigurations, order as defined in the OperationDefinition.

An endpoint to use to access terminology (i.e. valuesets, codesystems, naming systems, concept maps, and membership testing) referenced by the Resource. If no terminology endpoint is supplied, the server may use whatever mechanism is appropriate for accessing terminology. This could be the server on which the operation is invoked or a third party server accessible to the environment. When a terminology endpoint is provided, the server or third party servers may still be used as fallbacks.

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.

The first resource returned in the resulting package will be an outcome manifest that describes the results of the packaging operation. Clients consuming package bundles SHALL examine the contents of these OperationOutcome resources to understand whether the bundle contains the expected content (e.g. if a ValueSet could not be expanded).

Servers generating packages SHALL include all the dependency resources referenced by the artifact that are known to the server and specified by the include parameters.

For example, a measure repository SHALL include all the required library resources, but would not necessarily have the ValueSet resources referenced by the measure.