Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Operations

  • ArtifactOperation
    • id
    • url
    • version
    • identifier
    • resource
    • scope Defines the scope of the operation as a string of the form {namespace-name}[@{namespace-uri}]. Namespace name shall be a valid NPM package id, and namespace uri shall be a valid uri. For FHIR implementation guides, scope is inferred using the package id and the base canonical. e.g. fhir.cqf.common@http://fhir.org/guides/cqf/common. In the absence of an explicit scope declaration in an operation, the scope of the operation is determined by the focus artifact of the operation (i.e. the Measure in $evaluate-measure, or the Library in $evaluate). See the cqf-scope extension for a description of how the scope of an artifact is determined.
  • PageableOperation
    • offset
    • count
  • CanonicalVersionableOperation
    • canonicalVersion
    • checkCanonicalVersion
    • forceCanonicalVersion
  • ManifestableOperation
    • manifest
  • EndpointConfigurableOperation
    • endpointConfiguration 0..* A list of content or terminology endpoints in priority order, optionally with canonical route information. When resolving for a particular artifact, use these in definition order, if a canonical route is present, if the resolving url starts with the route (up to and including the entire url), then that endoint is used to attempt the resolution. If successful, the resolved artifact is returned, otherwise processing continues. If all endpoints are reached and either no match is found or no successful resolution occurs, servers may attempt local resolution of the artifact. If no resolution occurs, then an error is returned. Any errors encountered during processing should be collected and returned with the result.
      • canonicalRoute 0..1 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 0..1 The URI of the endpoint, exclusive with the endpoint parameter
      • endpoint 0..1 An Endpoint resource describing the endpoint, exclusive with the endpointUri parameter

Options for federated client specification:

  • 0
    • canonicalRoute: http://cts.nlm.org/fhir/ValueSet/
    • endpointUri: http://uat-cts.nlm.org/fhir
  • 1
    • canonicalRoute: http://cts.nlm.org/fhir/ValueSet/
    • endpointUri: http://apelon-dts
  • 2
    • endpointUri: http://tx.fhir.org
  • Route
    • canonicalRoute: http://cts.nlm.org/fhir/ValueSet/
    • endpointUri
      • 0: http://uat-cts.nlm.org/fhir
      • 1: http://apelon-dts
      • 2: http://tx.fhir.org

* * http://cts.nlm.org/ * * http://cts.nlm.org/ * endpointUri: http://uat-cts.nlm.org/fhir * * http://cts.nlm.org/ * endpointUri: http://apelon-dts.com/fhir * * http://terminology.hl7.org/ * endpointUri: http://tx.fhir.org * * http://hl7.org/fhir/ * endpointUri: http://tx.fhir.org

  • Resource/$package
    • id
    • url
    • version
    • identifier
    • capability
    • canonicalVersion
    • checkCanonicalVersion
    • forceCanonicalVersion
    • manifest
    • offset
    • count
    • include
    • packageOnly
    • contentEndpoint
    • terminologyEndpoint
  • Resource/$data-requirements
    • id
    • url
    • version
    • identifier
    • expression
    • parameters
    • canonicalVersion
    • checkCanonicalVersion
    • forceCanonicalVersion
    • manifest
    • include
    • contentEndpoint
    • terminologyEndpoint
  • Resource/$draft
    • id
    • url
    • version
    • identifier
    • resource
  • Resource/$approve
    • id
    • url
    • version
    • identifier
    • resource
    • approvalDate
    • artifactAssessmentType
    • artifactAssessmentSummary
    • artifactAssessmentTarget
    • artifactAssessmentRelatedArtifact
    • artifactAssessmentAuthor
  • Resource/$revise
    • id
    • url
    • version
    • identifier
    • resource
  • Resource/$review
    • id
    • url
    • version
    • identifier
    • resource
  • Resource/$endorse
    • id
    • url
    • version
    • identifier
    • resource
  • Resource/$release
    • id
    • url
    • version
    • identifier
    • resource
    • versionBehavior
    • latestFromTxServer
  • ActivityDefinition/$apply
  • PlanDefinition/$apply
  • Resource/$apply
  • Measure/$evaluate-measure
  • Measure/$care-gaps
  • Measure/$collect-data
  • Measure/$submit-data
  • StructureDefinition/$questionnaire
  • ValueSet/$expand
    • url
    • valueSet
    • valueSetVersion
    • context
    • contextDirection
    • filter
    • date
    • offset
    • count
    • includeDesignations
    • designation
    • includeDefinition
    • activeOnly
    • excludeNested
    • excludeNotForUI
    • excludePostCoordinated
    • displayLanguage
    • exclude-system
    • system-version
    • check-system-version
    • force-system-version
    • canonicalVersion
    • checkCanonicalVersion
    • forceCanonicalVersion
    • manifest
    • expansion
    • includeDraft