In FHIR STU3 standard, MedicationStatement
resource is representing a record of a medication that is being consumed by a patient.
In this RESTful API, this resource is utilized to describe medications in CCDS.
A MedicationStatement
may indicate that the patient may be taking the medication now, or has taken the medication in the past or will be taking the medication in the future
Required or some important fields and parameters would be given in the following tables. Operations and parameters of this resource would also be listed.
Resource Element Fields
Name | Description | Type |
---|---|---|
identifier | The identifier for this specific condition resource | Identifier |
status | Status of the medication | code (MedicationStatementStatus) |
category | Category of the medication | CodeableConcept (MedicationStatementCategory) |
medication | Specify what medication was taken |
medicationCodeableConcept: CodeableConcept (SNOMED CT Medication Codes) medicationReference: Reference (Medication) |
effect | The date/time or interval when the medication was taken |
effectiveDateTime: dateTime effectivePeriod: Period |
subject | Who and/or what this is about | Reference (Patient | Group) |
taken | If the medication was taken | code (MedicationStatementTaken) |
Get Medications by Patient
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement?patient={id}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement?patient=232
Search Medications With Specific Date
For this resource, users are able to search using parameters like effective, patient, and category etc. Important searching parameters would be listed in the following table.
Parameter Name | Description | Type | Required |
---|---|---|---|
_id | The Id of the certain resource | string | False |
identifier | The unique identifier for medications | string | False |
effective | Query date/time or interval when the medication was taken | dateTime | False |
patient | The Id representing the specific patient | integer | True (If the query is concerning a specific patient) |
category | The category of this medication | string | False |
code | Identify the medication | string | False |
subject | Who and/or what this is about | string | False |
This following request format indicates how to get medications on a specific date, by limiting a 1-day date range.
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement?patient={id}&effective=>={dateTime}effective=<{dateTime + 1 day}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement?patient=232&effective=>=2015-06-22&effective=<2015-06-23
Search Medications With a Date Range
The request format would be like:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement?patient={id}&effeciive=>={dateTime}&effective=<{dateTime (later than previous dateTime)}
Example:
GET https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement?patient=232&effective=>=2015-05-22&effective=<2015-07-22
{
"resourceType": "Bundle",
"id": "958ccbd2-bf09-4ee0-99b0-229557afbda4",
"meta": {
"lastUpdated": "2017-12-20T15:10:59.434-06:00"
},
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement?effective=%3E%3D2015-05-22&effective=%3C2015-07-22&patient=232"
}
],
"entry": [
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement/237",
"resource": {
"resourceType": "MedicationStatement",
"id": "237",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-15T15:18:36.000-06:00"
},
"medicationReference": {
"reference": "Medication/238"
},
"effectivePeriod": {
"start": "2015-06-22T00:00:00-04:00",
"end": "2015-06-30T00:00:00-04:00"
},
"subject": {
"reference": "Patient/232"
},
"dosage": [
{
"timing": {
"repeat": {
"frequency": 2,
"period": 1,
"periodUnit": "d"
}
},
"route": {
"coding": [
{
"system": "2.16.840.1.113883.3.26.1.1",
"code": "C48623",
"display": "Injection"
}
]
},
"doseQuantity": {
"value": 1
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement/239",
"resource": {
"resourceType": "MedicationStatement",
"id": "239",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-15T15:18:36.000-06:00"
},
"medicationReference": {
"reference": "Medication/240"
},
"effectivePeriod": {
"start": "2015-06-22T00:00:00-04:00",
"end": "2015-07-01T00:00:00-04:00"
},
"subject": {
"reference": "Patient/232"
},
"dosage": [
{
"asNeededBoolean": true,
"route": {
"coding": [
{
"system": "2.16.840.1.113883.3.26.1.1",
"code": "C38288",
"display": "Oral"
}
]
},
"doseQuantity": {
"value": 1,
"unit": "unit"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/MedicationStatement/241",
"resource": {
"resourceType": "MedicationStatement",
"id": "241",
"meta": {
"versionId": "1",
"lastUpdated": "2017-12-15T15:18:36.000-06:00"
},
"medicationReference": {
"reference": "Medication/242"
},
"effectivePeriod": {
"start": "2015-06-22T00:00:00-04:00"
},
"subject": {
"reference": "Patient/232"
},
"dosage": [
{
"timing": {
"repeat": {
"frequency": 1,
"period": 1,
"periodUnit": "wk"
}
},
"route": {
"coding": [
{
"system": "2.16.840.1.113883.3.26.1.1",
"code": "C48623",
"display": "Injection"
}
]
},
"doseQuantity": {
"value": 1
}
}
]
},
"search": {
"mode": "match"
}
}
]
}