Medication requests

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Examples

GET /MedicationRequest?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "f4b9e9fcf792aa460ae847b53b73895b",
  "type": "search set",
  "entry": [
    {
      "full_url": "/MedicationRequest/1008",
      "resource": {
        "resourceType": "MedicationRequest",
        "id": "1008",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
          ]
        },
        "status": "completed",
        "intent": "proposal",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
                "code": "community",
                "display": "Community"
              }
            ]
          }
        ],
        "reportedBoolean": true,
        "medicationCodeableConcept": {
          "coding": [
            {
              "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
              "code": "1243440",
              "display": "Tylenol 650 MG 8HR Extended Release Oral Tablet"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": " "
        },
        "encounter": {
          "reference": "Encounter/{}",
          "display": "Office Visit"
        },
        "authoredOn": "2022-10-17T13:58:25-04:00",
        "requester": {
          "reference": "Practitioner/",
          "display": "Albert Davis"
        },
        "dosageInstruction": [
          {
            "text": "Take 1 By  1"
          }
        ]
      }
    }
  ],
  "total": 1
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
patient optional	ID of the requested patient Validations: Must be number.
status optional	Status of the medication request e.g. “proposal” Validations: Must be string.
intent optional	Intent of medication request e.g. “plan” Validations: Must be string.
start_date optional	Start date for dataset; Format YYYY-MM-DD Validations: Must be Date.
end_date optional	End date for dataset; Format YYYY-MM-DD Validations: Must be Date.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Bundle Validations: Must be String.
type required	Validations: Must be String.

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Examples

GET /MedicationRequest/1008?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "MedicationRequest",
  "id": "1008",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
    ]
  },
  "status": "completed",
  "intent": "proposal",
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
          "code": "community",
          "display": "Community"
        }
      ]
    }
  ],
  "reportedBoolean": true,
  "medicationCodeableConcept": {
    "coding": [
      {
        "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code": "1243440",
        "display": "Tylenol 650 MG 8HR Extended Release Oral Tablet"
      }
    ]
  },
  "subject": {
    "reference": "Patient/1",
    "display": " "
  },
  "encounter": {
    "reference": "Encounter/{}",
    "display": "Office Visit"
  },
  "authoredOn": "2022-10-17T13:58:25-04:00",
  "requester": {
    "reference": "Practitioner/",
    "display": "Albert Davis"
  },
  "dosageInstruction": [
    {
      "text": "Take 1 By  1"
    }
  ]
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
id optional	ID of requested medication request Validations: Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	MedicationRequest Validations: Must be String.
status required	Validations: Must be String.
intent required	Validations: Must be String.
category required	Validations: Must be Array.
reported_boolean required	Validations: Must be String.
medication_codeable_concept required	Validations: Must be Hash.
subject required	Validations: Must be Hash.
encounter required	Validations: Must be Hash.
authored_on required	Validations: Must be String.
requester required	Validations: Must be Hash.
dosage_instruction required	Validations: Must be Array.

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
patient optional	ID of the requested patient Validations: Must be number.
status optional	Status of the medication request e.g. “proposal” Validations: Must be string.
intent optional	Intent of medication request e.g. “plan” Validations: Must be string.
start_date optional	Start date for dataset; Format YYYY-MM-DD Validations: Must be Date.
end_date optional	End date for dataset; Format YYYY-MM-DD Validations: Must be Date.