Page Status: updated 2024-06-14
OperationDefinition
Page index
Introduction
OperationDefinition resources are used to define special operations and named queries.
Operations can execute on three different levels:
- system level (
POST or GET [base]/[operation]), - resource type level (
POST or GET [base]/[resource]/[operation]) or - instace level (
POST or GET [base]/[resource]/[id]/[operation]).
It is specified on each OperationDefinition on what level and resourse it can be used. It is also specified on each resource in the guide if there are any operations available.
Defined operations
| Operation | Level | Link |
|---|---|---|
| $cancel-prescription | [base]/MedicationRequest/[id]/ |
NLLCancelPrescription |
| $end | [base]/MedicationRequest/ |
NLLEnd |
| $getAllInvalid | [base]/Basic/ |
NLLGetNotApprovedMDDB |
| $monitoring | [base]/MedicationRequest/ |
NLLMonitoring |
| $patient-dosage-directions | [base]/ |
NLLPatientDosageDirections |
| $ping | [base]/ |
NLLPing |
[base]/MedicationRequest/[id]/ |
NLLPrintOriginal | |
| $print-dispenses | [base]/Patient/[id]/ |
NLLPrintDispenses |
| $print-dose-prescriptions | [base]/Patient/[id]/ |
NLLPrintDosePrescriptions |
| $print-prescriptions | [base]/Patient/[id]/ |
NLLPrintPrescriptions |
| $print-prescription-history | [base]/MedicationRequest/[id]/ |
NLLPrintPrescriptionHistory |
| $restore | [base]/MedicationRequest/[id]/_history/[vid] |
NLLRestore |
| $translate | [base]/ConceptMap/[base]/ConceptMap/[id]/ |
NLL $translate |
| $validate-code | [base]/ValueSet/[id]/ |
NLL $validate-code |
| $verify | [base]/1[base]/MedicationDispense/[base]/MedicationRequest/ |
NLLVerify |
1The system level operation is used in a request with a Bundle of MedicationDispenses.