Page Status: updated 2025-03-31
NLLEnd
Page index
Definition
Invocations
URL: [base]/MedicationRequest/$end
This operation changes content
Parameters (In)
| Name | Cardinality | Type | Documentation |
| entry | 1..* | Data about the MedicationRequest(s) that shall be stopped (sv Avsluta) or cancelled (sv Makulera). | |
| entry.resource | 0..1 | Reference(NLLReference) | NB! Either a reference OR a NEF-id (PrescriptionSetId, RowId and ProductRowId) must be provided. Reference to a MedicationRequest that shall be stopped (sv Avsluta) or cancelled (sv Makulera) on either of the following formats MedicationRequest/[id] OR MedicationRequest/[id]/_history/[vid]. In the case that the reference contains a specific version (/_history/[vid]) the version-information will be ignored. |
| entry.PrescriptionSetId | 0..1 | string | NB! Either a reference OR a NEF-id (PrescriptionSetId, RowId and ProductRowId) must be provided. The PrescriptionSetId used in the NEF-id. Can be in combination with RowId and ProductRowId. The provided combination of NEF-id-parts must resolve to a uniqe prescription. (sv Originalordinations-id) |
| entry.RowId | 0..1 | positiveInt | The RowId used in the NEF-id. Used in combination with PrescriptionSetId and ProductRowId. (sv Radnummer) |
| entry.ProductRowId | 0..1 | positiveInt | The ProductRowId used in the NEF-id. Used in combination with PrescriptionSetId and RowId. (sv Produktradnummer) |
| entry.reason | 1..1 | CodeableConcept(NLLProvenanceReason) | Reason the activity is occurring. Will be used in the linked Provenance. (sv Händelseorsak) |
| entry.activity | 1..1 | CodeableConcept(NLLProvenanceActivity) | Activity that occurred. Will be used in the linked Provenance. (sv Händelsetyp) |
| entry.nllUsageEndDate | 0..1 | End date for dosage usage (sv: Sista doseringsdag) | |
| entry.nllUsageEndDate.operationType | 1..1 | code | replace | delete The operation that should be applied on the UsageEndDate. It can be replaced with a new date, or it can be deleted. |
| entry.nllUsageEndDate.date | 0..1 | date | The date value that UsageEndDate shall get. Used in combination with the OperationType "replace". |
| entry.nllTreatmentEndDate | 0..1 | Last date for ending this treatment (sv: Senaste datum för avslut) | |
| entry.nllTreatmentEndDate.operationType | 1..1 | code | replace | delete The operation that should be applied on the TreatmentEndDate. It can be replaced with a new date, or it can be deleted. |
| entry.nllTreatmentEndDate.date | 0..1 | date | The date value that TreatmentEndDate shall get. Used in combination with the OperationType "replace". |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
| result | 0..1 | boolean | In the case of a successfull call, the result is set to "true" |
Can be invoked with a HTTP POST. This operation is used for stopping (sv Avsluta) or cancelling (sv Makulera) one or several prescriptions using their logical ids. In the case of an unsuccessfull transaction, an OperationOutcom is returned.
Examples
See Examples - NLLEnd.