ArtifactEndpointConfigurableOperation

CRMI Operation Profile: Artifact Endpoint Configurable

activeCanonical Resource Management Infrastructure Implementation Guide1.0.0resource4 key elements

Profile for operations where artifact endpoint configuration can be specified.

  • `artifactEndpointConfiguration`: 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 `artifactEndpointConfiguration`s

* 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 `artifactEndpointConfiguration`s, order as defined in the OperationDefinition.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-artifact-endpoint-configurable-operation
ID
crmi-artifact-endpoint-configurable-operation
Type
Base Definition
Derivation
constraint
Mandatory and Must-Support Elements

Elements with cardinality > 0 or marked as Must Support (S)

PathCard.TypeFlagsDescription
:artifactEndpointConfiguration0..*
S
:artifactRoute0..1
BackboneElement
S
:endpointUri0..1
BackboneElement
S
:endpoint0..1
BackboneElement
S