STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

1.5 Defined RESTful API Operations

The RESTful API defines a set of common interactions (read, update, search, etc.) performed on a repository of typed resources. For further information concerning how operations are defined and invoked, see Extended Operations on the RESTful API.

This is a full list of the operations defined by this specification:

Base Operations (All resource types)
Validate a resource[base]/[Resource]/$validate | [base]/[Resource]/[id]/$validate
Access a list of profiles, tags, and security labels[base]/$meta | [base]/[Resource]/$meta | [base]/[Resource]/[id]/$meta
Add profiles, tags, and security labels to a resource[base]/[Resource]/[id]/$meta-add
Delete profiles, tags, and security labels for a resource[base]/[Resource]/[id]/$meta-delete
The CDS Hook operation is the core API request for CDS Hooks[base]/$cds-hook
Operations Defined by Resource Types
Apply[base]/ActivityDefinition/[id]/$apply
Data Requirements[base]/ActivityDefinition/[id]/$data-requirements
Concept Look Up[base]/CodeSystem/$lookup
Subsumption Testing[base]/CodeSystem/$subsumes | [base]/CodeSystem/[id]/$subsumes
Performing inferencing based on a set of codes - e.g. a mix of composition and decomposition[base]/CodeSystem/$infer | [base]/CodeSystem/[id]/$infer
Generate a Document[base]/Composition/$document | [base]/Composition/[id]/$document
Concept Translation[base]/ConceptMap/$translate | [base]/ConceptMap/[id]/$translate
Closure Table Maintenance[base]/$closure
Fetch a subset of the conformance resource[base]/Conformance/$subset | [base]/Conformance/[id]/$subset
Test if a server implements a client's required operations[base]/Conformance/$implements | [base]/Conformance/[id]/$implements
Test if a server implements a client's required operations[base]/Conformance/$conforms
Evaluate[base]/DecisionSupportServiceModule/[id]/$evaluate
Data Requirements[base]/DecisionSupportServiceModule/[id]/$data-requirements
Fetch Encounter Record[base]/Encounter/[id]/$everything
Data Requirements[base]/$data-requirements | [base]/Library/[id]/$data-requirements
Find a functional list[base]/List/$find
Evaluate Measure[base]/Measure/$evaluate-measure | [base]/Measure/[id]/$evaluate-measure
Data Requirements[base]/Measure/[id]/$data-requirements
Process Message[base]/$process-message
Observation Statistics[base]/Observation/$stats | [base]/Observation/[id]/$stats
Find patient matches using MPI based logic[base]/Patient/$match
Fetch Patient Record[base]/Patient/$everything | [base]/Patient/[id]/$everything
Place[base]/PlanDefinition/[id]/$apply
Data Requirements[base]/PlanDefinition/[id]/$data-requirements
Populate Questionnaire[base]/Questionnaire/$populate | [base]/Questionnaire/[id]/$populate
Geneate HTML for Questionnaire[base]/Questionnaire/$populatehtml | [base]/Questionnaire/[id]/$populatehtml
Generate a link to a Questionnaire completion webpage[base]/Questionnaire/$populatelink | [base]/Questionnaire/[id]/$populatelink
Build Questionnaire[base]/StructureDefinition/$questionnaire | [base]/StructureDefinition/[id]/$questionnaire
Model Instance Transformation[base]/StructureMap/$transform | [base]/StructureMap/[id]/$transform
Reserve Task[base]/Task/[id]/$reserve
Start Task[base]/Task/[id]/$start
Finish Task[base]/Task/[id]/$finish
Fail Task[base]/Task/[id]/$fail
Release Task[base]/Task/[id]/$release
Suspend Task[base]/Task/[id]/$suspend
Resume Task[base]/Task/[id]/$resume
Cancel Task[base]/Task/[id]/$cancel
Stop Task[base]/Task/[id]/$stop
Set Task Input[base]/Task/[id]/$set-input
Set Task Output[base]/Task/[id]/$set-output
Value Set Expansion[base]/ValueSet/$expand | [base]/ValueSet/[id]/$expand
Value Set based Validation[base]/ValueSet/$validate-code | [base]/ValueSet/[id]/$validate-code
Operations Defined by Implementation Guides

Notes:

  • The special operations on the meta element also operate on previous versions of a resource (/_history/). They are the only operations that can manipulate versions other than the "current" version.
  • Implementation Guides can define additional operations