Skip to main content

XIS MedicationRequest FHIR API (1.0.0)

Download OpenAPI specification:Download

Search for available medications the patient can order.

Responses

Response samples

Content type
application/fhir+json
{
  • "resourceType": "Bundle",
  • "meta": {
    },
  • "type": "searchset",
  • "total": 1,
  • "entry": [
    ]
}

Get a specific MedicationRequest by ID.

path Parameters
id
required
string
Example: example-medication-request-id-1

Responses

Response samples

Content type
application/fhir+json
{
  • "resourceType": "MedicationRequest",
  • "id": "example-medication-request-id-1",
  • "extension": [],
  • "status": "active",
  • "medicationReference": {
    },
  • "subject": {
    },
  • "performer": {
    },
  • "dispenseRequest": {
    },
  • "intent": "order"
}

Order a medication

Request Body schema: application/fhir+json
required
resourceType
required
string
Value: "MedicationRequest"
required
Array of objects
status
required
string
Value: "draft"

The status is always set to "draft" when Spreekuur.nl is creating a new MedicationRequest.

required
object
required
object
required
object

This is the pharmacy where the patient can collect the medication.

required
object
authoredOn
required
string <date-time>

The date and time when the new MedicationRequest was created. This is set to the current time when the request is made.

Array of objects
required
Array of objects
intent
required
string
Value: "order"

The intent of the MedicationRequest. For new requests, this is always set to "order".

Responses

Request samples

Content type
application/fhir+json
{
  • "resourceType": "MedicationRequest",
  • "extension": [],
  • "status": "draft",
  • "medicationReference": {
    },
  • "subject": {
    },
  • "performer": {
    },
  • "dispenseRequest": {
    },
  • "authoredOn": "2025-08-08T12:00:00+02:00",
  • "note": [
    ],
  • "basedOn": [
    ],
  • "intent": "order"
}

Search for pharmacies

query Parameters
identifier
required
Array of arrays
Example: identifier=http://fhir.nl/fhir/NamingSystem/agb-z|123456,http://fhir.nl/fhir/NamingSystem/agb-z|654321

Responses

Response samples

Content type
application/fhir+json
{
  • "resourceType": "Bundle",
  • "type": "searchset",
  • "total": 1,
  • "entry": [
    ]
}