Operation-canonicalresource-current-canonical

R6 Ballot (1st Draft)

This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

Example OperationDefinition/CanonicalResource-current-canonical (Narrative)

FHIR Infrastructure Work Group

Maturity Level: N/A

Standards Status: Informative

Compartments: No defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

Note that this is the formal definition for the current-canonical operation as an OperationDefinition on CanonicalResource. See the Operation documentation

URL: [base]/$current-canonical

URL: [base]/CanonicalResource/$current-canonical

Parameters

Use

Name

Scope

Cardinality

Type

Binding

Documentation

IN

url

1..1

uri

This is the canonical URL (with no version declared)

IN

status

0..*

code

The statuses to allow to be returned. If no status codes are provided, then any status is ok

OUT

result

0..1

CanonicalResource

If no resources can be found, will return nothing. If multiple resources are found for the specified statuses and 'most current' can't be determined by comparing the versions, the operation will fail with an operation outcome.

If none of the instances define the versionAlgorithm to use, a server may dynamically attempt to determine which versioning system is implied by the data.

If the instances found with the provided canonical URL define different versionAlgorithm values the server may return an error.

Note that the CanonicalResource is an interface and not an actual resource type, as such the operation is actually called on the canonical resource types such as CodeSystem, Questionnaire etc.

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.