Drug review
SFM will provide access to drug review information for patients through the DrugReviewInfo endpoint. This allows querying based on parameters such as the number of treatments, last drug review date, and planned medication review date.
Endpoint
The endpoint is accessed via:
GET /api/Basic?_query=drugReviewInfo
Purpose
The purpose of this endpoint is to provide a detailed view of drug review information, including the number of treatments, last review date, planned review date, and other relevant details.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| numberOfTreatments | int | No | Minimum number of active treatments a patient must have. |
| lastDrugReview | datetime | No | ISO 8601 format. Patient filter, last drug review dates before this date. |
| plannedDrugReview | datetime | No | ISO 8601 format. Patient filter, planned drug review dates after this date. |
Profile
{{link:StructureDefinition/sfm-DrugReviewInfo }} {{tree:StructureDefinition/sfm-DrugReviewInfo }}
Retrieval on Datashare
The actual retrieval of drug review data is performed using a named query on Basic. Parameters may include the registered patient identifier or a combination of treatments and timestamps:
GET [base]/Basic?_query=drugReviewInfo&numberOfTreatments=(min count)
GET [base]/Basic?_query=drugReviewInfo&lastDrugReview=lt(timestamp)
GET [base]/Basic?_query=drugReviewInfo&plannedDrugReview=gt(timestamp)
Note that SFM will return all matching entries based on the given parameters, and the number of items may grow during a typical session.
Example Request
GET /api/Basic?_query=drugReviewInfo&numberOfTreatments=3&lastDrugReview=2023-01-01T00:00:00Z&plannedDrugReview=2024-01-01T00:00:00Z
Example Response
{
"fullUrl": "http://datashare.dev1.forskrivning.no/Basic/5cb8995f-3913-4677-be0c-0e0ccb3dbe69",
"resource": {
"resourceType": "Basic",
"id": "5cb8995f-3913-4677-be0c-0e0ccb3dbe69",
"meta": {
"profile": [
"http://ehelse.no/fhir/StructureDefinition/SfmDrugReviewInfo"
]
},
"extension": [
{
"extension": [
{
"url": "patient-fhir-id",
"valueString": "5cb8995f-3913-4677-be0c-0e0ccb3dbe69"
},
{
"url": "number-of-medications",
"valueInteger": 17
},
{
"url": "number-of-fixed-usage-medications",
"valueInteger": 15
},
{
"url": "last-drug-review",
"valueDateTime": "2025-03-07T16:18:04.613+01:00"
},
{
"url": "planned-drug-review",
"valueDateTime": "2026-03-07T02:00:00+01:00"
},
{
"url": "last-review-comment",
"valueString": "example comment"
}
],
"url": "http://ehelse.no/fhir/StructureDefinition/SfmDrugReviewInfoExtension"
}
]
}
Usage Examples
Search by Number of Treatments
GET /Basic?_query=drugReviewInfo&numberOfTreatments=(nrOfTreatments)
Search by Number of Treatments and Minimum Last Drug Review Date
GET /Basic?_query=drugReviewInfo&numberOfTreatments=(nrOfTreatments)&lastDrugReview=(lastDrugReview)
Search by Number of Treatments and Maximum Planned Drug Review Date
GET /Basic?_query=drugReviewInfo&numberOfTreatments=(nrOfTreatments)&plannedDrugReview=(plannedDrugReview)
Search by Number of Treatments, Minimum Last Drug Review Date, and Maximum Planned Drug Review Date
GET /Basic?_query=drugReviewInfo&numberOfTreatments=(nrOfTreatments)&lastDrugReview=(lastDrugReview)&plannedDrugReview=(plannedDrugReview)
All requests require appropriate authorization headers:
Host: (host)
Content-Type: application/json
Accept: application/json
Authorization: Bearer (token)