Skip to content

Decide whether OperationDefinition canonical URLs should keep the $ prefix #372

Description

@johngrimes

Our OperationDefinitions use canonical URLs that include the $ invocation prefix, for example http://sql-on-fhir.org/OperationDefinition/$viewdefinition-run. The usual FHIR convention is for an OperationDefinition's canonical URL to omit the $ (the $ belongs to the invocation path, not the resource's identity), which would give http://sql-on-fhir.org/OperationDefinition/viewdefinition-run.

This came up while resolving #371, which aligned the run operation's name and corrected the CapabilityStatement guidance. We deliberately kept the $ prefix there, because changing it touches every operation and every page that cites a canonical - well beyond the scope of #371, whose own text treats .../$viewdefinition-run as the correct canonical.

Raising it separately so the decision is recorded: do we keep the $ prefix across all four operations ($viewdefinition-run, $viewdefinition-export, $sqlquery-run, $sqlquery-export), or move to the conventional form without $? Changing it would mean updating the FSH url values and every citing page in one coordinated change, and weighing the backwards-compatibility impact on anyone already referencing the current canonicals.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions