Skip to content

Get a Prescription

Request

Retrieve details of a specific prescription by its ID.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired

The ID of the prescription to retrieve.

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/prescriptions/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringrequired
external_prescription_idstringrequired
statusstringrequired
signed_atstring or null, (date-time)required
notesstring or nullrequired
medicinesArray of objectsrequired
patientobject or nullrequired
prescriberobject or nullrequired
Response
{ "id": "string", "external_prescription_id": "string", "status": "string", "signed_at": "2019-08-24T14:15:22Z", "notes": "string", "medicines": [ { … } ], "patient": { "id": "string", "first_name": "string", "last_name": "string" }, "prescriber": { "id": "string", "name": "string", "email": "user@example.com" } }