API Name: MedicationRequest.$retrieve


This API retrieves MedicationRequest record(s) representing medication orders associated with a patient, identified by the patient's NRIC identifier.

Specification


Endpoint [baseurl]/MedicationRequest/$retrieve
Protocol HTTPS
HTTP Method GET
HTTP Header Accept: application/fhir+json

Request Parameters

Parameter Type Cardinality Description
patient.identifier token 1..1 The patient's identifier in system\|value format. Use https://fhir.synapxe.sg/NamingSystem/nric\|<NRIC>.
date date 0..2 Filter by order date. Supports ge and le prefixes for date range (e.g. ge2026-01-01&date=le2026-06-30).
status token 0..1 Filter by order status (e.g. active, completed, cancelled).
_count number 0..1 Maximum number of results to return per page.

Example Request

GET [baseurl]/MedicationRequest/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|S1234567A

Successful Response

The response is a searchset Bundle containing the matching MedicationRequest resource(s), each conforming to Medication Request Profile.

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
textC0..1Narrative
medicationC0..1Medication
orderingLocationC0..1Extension(CodeableConcept)
orderSetConnectingTermC0..1Extension(CodeableConcept)
changesMadeC0..*Extension(Complex)
authorizerC0..*Extension(Reference(Practitioner))
orderingInstitutionC0..1Extension(Reference(Organization))
modifierExtensionΣ ?! C0..0Extension
id0..0string
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ C1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
recordIdentifierC0..1IdentifierRecordID
orderIDC1..1IdentifierOrderNo
sourceGroupingIDC1..1IdentifierSourceGroupingID
sequenceNoC0..1IdentifierSequenceNo
priorPrescriptionC0..0Reference(MedicationRequest)
id0..0string
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uriPattern
valueΣ C1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
statusΣ ?!1..1codeBinding
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..1string
statusChanged0..1dateTime
intentΣ ?!1..1codeBindingPattern
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..1string
priorityΣ0..0codeBinding
doNotPerformΣ ?!0..0boolean
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
referenceΣ C0..1string
typeΣ0..0uriBinding
id0..0string
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ C1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
displayΣ C0..1string
id0..0string
extensionC0..0Extension
referenceΣ C0..0string
typeΣ1..1uriBindingPattern
id0..0string
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ C1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
displayΣ C0..0string
informationSourceC0..0Reference(Organization | Patient | Practitioner | PractitionerRole | RelatedPerson)
encounterC0..1Reference(Encounter)
supportingInformationC0..0Reference(Resource)
authoredOnΣ1..1dateTime
id0..0string
extensionC0..0Extension
referenceΣ C0..0string
typeΣ1..1uriBindingPattern
id0..1string
extensionC0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ0..1uri
valueΣ C0..1string
periodΣ C0..1Period
assignerΣ C0..1Reference(Organization)
displayΣ C0..1string
reportedΣ0..0boolean
performerTypeΣ0..0CodeableConceptBinding
device0..0CodeableReference(DeviceDefinition)
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..1string
referenceΣ C0..1Reference
courseOfTherapyType0..0CodeableConceptBinding
insuranceC0..0Reference(ClaimResponse | Coverage)
note0..1Annotation
renderedDosageInstruction0..0markdown
id0..0string
extensionC0..0Extension
startΣ C1..1dateTime
endΣ C0..1dateTime
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
sequenceΣ0..1integer
textΣ0..1string
id0..0string
extensionC0..0Extension
codingΣ C0..0Coding
textΣ1..1string
patientInstructionΣ0..0string
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
eventΣ0..1dateTime
id0..0string
extensionC0..0Extension
boundsPeriodPeriod
countΣ C0..1positiveInt
countMaxΣ C0..1positiveInt
durationΣ C0..1decimal
durationMaxΣ C0..1decimal
durationUnitΣ C0..1codeBinding
frequencyΣ0..1positiveInt
frequencyMaxΣ0..1positiveInt
periodΣ C0..1decimal
periodMaxΣ C0..1decimal
periodUnitΣ C0..1codeBinding
dayOfWeekΣ0..1codeBinding
timeOfDayΣ C0..1time
whenΣ C0..1codeBinding
offsetΣ C0..1unsignedInt
id0..1string
extensionC0..*Extension
id0..1string
extensionC0..*Extension
systemΣ0..1uri
versionΣ0..1string
codeΣ C0..1code
displayΣ C0..1string
userSelectedΣ0..0boolean
textΣ0..1string
asNeededΣ C0..0boolean
id0..1string
extensionC0..0Extension
codingΣ C0..0Coding
textΣ1..1string
siteΣ0..0CodeableConcept
id0..0string
extensionC0..0Extension
id0..0string
extensionC0..0Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ C1..1code
displayΣ C1..1string
userSelectedΣ0..0boolean
textΣ0..1string
methodΣ0..0CodeableConcept
id0..0string
extensionC0..0Extension
typeΣ0..0CodeableConcept
doseQuantitySimpleQuantity
doseRangeRange
rateQuantitySimpleQuantity
rateRangeRange
rateRatioRatio
maxDosePerPeriodΣ C0..0Ratio
maxDosePerAdministrationΣ C0..0SimpleQuantity
maxDosePerLifetimeΣ C0..0SimpleQuantity
id0..0string
extensionC0..0Extension
modifierExtensionΣ ?! C0..0Extension
dispenseIntervalC0..0Duration
validityPeriodC0..0Period
numberOfRepeatsAllowed0..0unsignedInt
id0..0string
extensionC0..0Extension
valueΣ1..1decimal
comparatorΣ ?!0..0codeBinding
unitΣ1..1string
systemΣ C1..1uri
codeΣ C1..1code
id0..0string
extensionC0..0Extension
referenceΣ C0..0string
typeΣ1..1uriBindingPattern
id0..0string
extensionC0..0Extension
useΣ ?!0..0codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ C1..1string
periodΣ C0..0Period
assignerΣ C0..0Reference(Organization)
displayΣ C1..1string
dispenserInstruction0..0Annotation
doseAdministrationAid0..0CodeableConcept
eventHistoryC0..0Reference(Provenance)
{
"resourceType": "Bundle",
"id": "8a538943-e4f7-5c46-b7b0-b36b0adb98f9",
"meta": {
"lastUpdated": "2018-07-02T14:30:54+08:00"
},
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "MedicationRequest/$retrieve?patient.identifier=https://fhir.synapxe.sg/NamingSystem/nric|None"
}
],
"entry": [
{
"fullUrl": "urn:uuid:1629ee7a-e02d-51c9-a967-545edd4c0da0",
"resourceType": "MedicationRequest",
"id": "1629ee7a-e02d-51c9-a967-545edd4c0da0",
"meta": {
"versionId": "1",
"lastUpdated": "2018-07-02T14:30:54+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medicationrequest"
]
},
{
"resourceType": "Medication",
"id": "med-1001",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medication"
]
},
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Singapore_Drug_Dictionary-Compressed",
"code": "0002-20-89X-6",
"display": "warfarin sodium (MAREVAN) tablet"
}
]
},
"status": "active"
}
],
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderingInstitution",
"type": "Organization",
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "SGH"
}
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderingLocation",
"text": "WARD B10S"
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-authorizer",
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/prn",
"value": "106795D"
},
"display": "Doc Rivers"
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderSetConnectingTerm",
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/order-set-connecting-term",
"code": "Step Dose",
"display": "Step Dose"
}
]
}
}
],
{
"system": "https://fhir.synapxe.sg/NamingSystem/order-no",
"value": "S1549639H012"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/source-grouping-id",
"value": "1001"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/sequence-no",
"value": "1001"
}
],
"status": "active",
"intent": "order",
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_Order_Dispense_Type_(NEHR)",
"code": "Emergency",
"display": "Emergency"
}
]
}
],
"reference": "#med-1001"
}
},
"subject": {
"type": "Patient",
"system": "https://fhir.synapxe.sg/NamingSystem/mrn",
"value": "S1549639H"
}
},
"authoredOn": "2018-05-01T16:55:18+08:00",
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/prn",
"value": "106795D"
},
"display": "Doc Rivers"
},
"start": "2018-06-03T16:55:18+08:00"
},
{
"sequence": 1,
{
"text": "PRN Pain or Fever"
}
],
"route": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Route_of_Administration_(SHS-SCM)",
"code": "ORAL",
"display": "ORAL"
}
]
},
{
"value": 1
}
}
]
}
],
"value": 15,
"unit": "Tablet",
"system": "http://unitsofmeasure.org",
"code": "Tablet"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "urn:uuid:45d2e3bd-8052-521e-a550-ce665462f514",
"resourceType": "MedicationRequest",
"id": "45d2e3bd-8052-521e-a550-ce665462f514",
"meta": {
"versionId": "1",
"lastUpdated": "2018-07-02T14:30:54+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medicationrequest"
]
},
{
"resourceType": "Medication",
"id": "med-1002",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medication"
]
},
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Singapore_Drug_Dictionary-Compressed",
"code": "0000-28-72X-8",
"display": "Paracetamol 500 mg Tablet"
}
]
},
"status": "inactive",
{
"item": {
"concept": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Singapore_Drug_Dictionary-Compressed",
"code": "0000-28-72X-8",
"display": "Paracetamol 500 mg Tablet"
}
]
}
},
"value": 1000,
"unit": "mg"
}
}
]
}
],
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderingInstitution",
"type": "Organization",
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "SGH"
}
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderingLocation",
"text": "WARD B10S"
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-authorizer",
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/prn",
"value": "106795D"
},
"display": "Doc Rivers"
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderSetConnectingTerm",
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/order-set-connecting-term",
"code": "Step Dose",
"display": "Step Dose"
}
]
}
}
],
{
"system": "https://fhir.synapxe.sg/NamingSystem/order-no",
"value": "S1549639H012"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/source-grouping-id",
"value": "1001"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/sequence-no",
"value": "1002"
}
],
"status": "completed",
"intent": "order",
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_Order_Dispense_Type_(NEHR)",
"code": "Emergency",
"display": "Emergency"
}
]
}
],
"reference": "#med-1002"
}
},
"subject": {
"type": "Patient",
"system": "https://fhir.synapxe.sg/NamingSystem/mrn",
"value": "S1549639H"
}
},
"authoredOn": "2018-05-01T16:55:18+08:00",
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/prn",
"value": "106795D"
},
"display": "Doc Rivers"
},
"start": "2018-06-03T16:55:18+08:00"
},
{
"sequence": 1,
{
"text": "PRN Pain or Fever"
}
],
"route": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Route_of_Administration_(SHS-SCM)",
"code": "ORAL",
"display": "ORAL"
}
]
},
{
"value": 250
}
}
]
}
],
"value": 10,
"unit": "Tablet",
"system": "http://unitsofmeasure.org",
"code": "Tablet"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "urn:uuid:b94e5262-94ce-5ff7-8a8e-7cb11e3ebbb2",
"resourceType": "MedicationRequest",
"id": "b94e5262-94ce-5ff7-8a8e-7cb11e3ebbb2",
"meta": {
"versionId": "1",
"lastUpdated": "2018-07-02T14:30:54+08:00",
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medicationrequest"
]
},
{
"resourceType": "Medication",
"id": "med-1003",
"meta": {
"profile": [
"https://fhir.synapxe.sg/StructureDefinition/profile-medication"
]
},
"code": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Singapore_Drug_Dictionary-Compressed",
"code": "0000-10-25X-2",
"display": "Prazosin Tablet"
}
]
},
"status": "active",
{
"item": {
"concept": {
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Singapore_Drug_Dictionary-Compressed",
"code": "0000-10-25X-2",
"display": "Prazosin Tablet"
}
]
}
},
"value": 1000,
"unit": "mg"
}
}
]
}
],
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderingInstitution",
"type": "Organization",
"system": "https://fhir.synapxe.sg/NamingSystem/hci-code",
"value": "SGH"
}
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-orderingLocation",
"text": "WARD B10S"
}
},
{
"url": "https://fhir.synapxe.sg/StructureDefinition/ext-authorizer",
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/prn",
"value": "106795D"
},
"display": "Doc Rivers"
}
}
],
{
"system": "https://fhir.synapxe.sg/NamingSystem/order-no",
"value": "S1549639H012"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/source-grouping-id",
"value": "1001"
},
{
"system": "https://fhir.synapxe.sg/NamingSystem/sequence-no",
"value": "1003"
}
],
"status": "active",
"statusChanged": "2018-09-03T08:39:38.000+08:00",
"intent": "order",
{
"coding": [
{
"system": "https://fhir.synapxe.sg/CodeSystem/Med_Order_Dispense_Type_(NEHR)",
"code": "Emergency",
"display": "Emergency"
}
]
}
],
"reference": "#med-1003"
}
},
"subject": {
"type": "Patient",
"system": "https://fhir.synapxe.sg/NamingSystem/mrn",
"value": "S1549639H"
}
},
"authoredOn": "2018-05-01T16:55:18+08:00",
"type": "Practitioner",
"system": "https://fhir.synapxe.sg/NamingSystem/prn",
"value": "106795D"
},
"display": "Doc Rivers"
},
"start": "2018-06-03T16:55:18+08:00",
"end": "2018-09-03T08:39:38.000+08:00"
},
{
"sequence": 1,
"text": "Take 100 mg once in two weeks.",
{
"text": "Still have. Do not supply."
}
],
"timing": {
"repeat": {
"period": 10,
"periodUnit": "d"
},
"code": {
"text": "ONCE IN 2 WEEKS"
}
},
{
"unit": "mg"
}
}
]
}
]
},
"search": {
"mode": "match"
}
}
]
}

Business Level Errors


This section details the business level errors exposed by OperationOutcome resource for this operation. Refer to API Error Handling for framework level errors.

For illustration only

http status code code details.coding.code details.text
404 not-found E-10000 No matching patient found based on NRIC, Date of Birth and Gender
404 not-found E-10001 Institution code for organization is not found
404 not-found E-10002 Organization code is not found
400 business-rule E-10003 Patient is not currently enrolled to the organization
400 duplicate E-10004 An attempt was made to create a duplicate record
400 invalid E-10005 Invalid allergy intolerance identifier
400 invalid E-10006 Invalid clinical or verification status