api-docs v5.116.0

API Docs

Table of contents

Pharmacy_Medication_Order

Pharmacy Medication Order - Delete

Back to top

Delete a specific pharmacy medication order

DELETE /pharmacy-medication-orders/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/pharmacy-medication-orders/<pharmacy-medication-order-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string

associated organization's (facility) id
medicalRecordOrder string

reference to a patient's medical-records#medication-order
inventoryTransaction string

reference to origin inventory-transactions
medicine string
prescribee string

patient id or personal details id
prescribeeType string Allowed values: patient,personal-details
issuedAt number

defaults to creation date
diagnosis string
customReferenceId string

external prescription no. defaults to #id
prescriber string

uid of prescriber's account
spfddsn string
items object[]
items.id string Default value: auto-generated-id
items.medicalRecordItemId string

reference to medical-records#medication-order#item#id
items.inventoryTransactionItemId string

reference to inventory-transactions#items#id
items.medicine string

reference to medicines#id
items.genericName string
items.brandName string
items.strength number
  • amount of drug in the dosage form

examples (combined with strengthUnit and dosageForm)

  • 500 mg capsule
  • 250 mg/5 mL suspension
items.strengthUnit string

examples

  • mg
items.dosageForm string
  • physical form of a dose of a the drug
items.dosageString string
  • string representation of amount + dosageForm + frequency

examples

  • tablet
  • capsule
  • ointment
  • aerosol
  • patch
  • suspension
  • injection
  • etc.
items.amount number
  • dose
  • specified amount of medication taken at one time
items.route string
  • the way the dosage form is written

examples

  • oral
  • rectal
  • inhalation
  • nasal
  • topical
  • etc.
items.formulation string

string representation/combinations of

  • strength
  • strengthUnit
  • dosageForm
  • route

examples

  • 120 mg/5 mL (125 mg/5 mL) suspension, 30 mL (alcohol-free)
  • 250 mg/5 mL syrup, 30 mL (alcohol-free)
items.frequency string
  • combind with dose (and doseUnit), defines the dosage regimen

examples (combined with dose, doseUnit, optional dosageForm)

  • 2.5 mL twice a day
items.sig string
  • instruction to patient

historically

  • lt. signature
  • to be written by pharmacist in the packaging of the medicine (for recipe)
items.dispense number
  • number of units to be given to the patient
items.dispenseUnit string
  • usually just the same as the dosageForm
items.refills number
  • number of allowed refills for the particular prescription
items.isDangerous boolean
  • flag if the medicine is considered a dangerous drug

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Pharmacy Medication Order - Find

Back to top

Get list of pharmacy medication orders

GET /pharmacy-medication-orders

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/pharmacy-medication-orders" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
pharmacyMedicationOrders object[]

array of pharmacyMedicationOrder
pharmacyMedicationOrders.id string
pharmacyMedicationOrders.createdAt number
pharmacyMedicationOrders.createdBy string
pharmacyMedicationOrders.organization string

associated organization's (facility) id
pharmacyMedicationOrders.medicalRecordOrder string

reference to a patient's medical-records#medication-order
pharmacyMedicationOrders.inventoryTransaction string

reference to origin inventory-transactions
pharmacyMedicationOrders.medicine string
pharmacyMedicationOrders.prescribee string

patient id or personal details id
pharmacyMedicationOrders.prescribeeType string Allowed values: patient,personal-details
pharmacyMedicationOrders.issuedAt number

defaults to creation date
pharmacyMedicationOrders.diagnosis string
pharmacyMedicationOrders.customReferenceId string

external prescription no. defaults to #id
pharmacyMedicationOrders.prescriber string

uid of prescriber's account
pharmacyMedicationOrders.spfddsn string
pharmacyMedicationOrders.items object[]
pharmacyMedicationOrders.items.id string Default value: auto-generated-id
pharmacyMedicationOrders.items.medicalRecordItemId string

reference to medical-records#medication-order#item#id
pharmacyMedicationOrders.items.inventoryTransactionItemId string

reference to inventory-transactions#items#id
pharmacyMedicationOrders.items.medicine string

reference to medicines#id
pharmacyMedicationOrders.items.genericName string
pharmacyMedicationOrders.items.brandName string
pharmacyMedicationOrders.items.strength number
  • amount of drug in the dosage form

examples (combined with strengthUnit and dosageForm)

  • 500 mg capsule
  • 250 mg/5 mL suspension
pharmacyMedicationOrders.items.strengthUnit string

examples

  • mg
pharmacyMedicationOrders.items.dosageForm string
  • physical form of a dose of a the drug
pharmacyMedicationOrders.items.dosageString string
  • string representation of amount + dosageForm + frequency

examples

  • tablet
  • capsule
  • ointment
  • aerosol
  • patch
  • suspension
  • injection
  • etc.
pharmacyMedicationOrders.items.amount number
  • dose
  • specified amount of medication taken at one time
pharmacyMedicationOrders.items.route string
  • the way the dosage form is written

examples

  • oral
  • rectal
  • inhalation
  • nasal
  • topical
  • etc.
pharmacyMedicationOrders.items.formulation string

string representation/combinations of

  • strength
  • strengthUnit
  • dosageForm
  • route

examples

  • 120 mg/5 mL (125 mg/5 mL) suspension, 30 mL (alcohol-free)
  • 250 mg/5 mL syrup, 30 mL (alcohol-free)
pharmacyMedicationOrders.items.frequency string
  • combind with dose (and doseUnit), defines the dosage regimen

examples (combined with dose, doseUnit, optional dosageForm)

  • 2.5 mL twice a day
pharmacyMedicationOrders.items.sig string
  • instruction to patient

historically

  • lt. signature
  • to be written by pharmacist in the packaging of the medicine (for recipe)
pharmacyMedicationOrders.items.dispense number
  • number of units to be given to the patient
pharmacyMedicationOrders.items.dispenseUnit string
  • usually just the same as the dosageForm
pharmacyMedicationOrders.items.refills number
  • number of allowed refills for the particular prescription
pharmacyMedicationOrders.items.isDangerous boolean
  • flag if the medicine is considered a dangerous drug

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Pharmacy Medication Order - Get

Back to top

Get a specific pharmacy medication order

GET /pharmacy-medication-orders/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/pharmacy-medication-orders/<pharmacy-medication-order-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string

associated organization's (facility) id
medicalRecordOrder string

reference to a patient's medical-records#medication-order
inventoryTransaction string

reference to origin inventory-transactions
medicine string
prescribee string

patient id or personal details id
prescribeeType string Allowed values: patient,personal-details
issuedAt number

defaults to creation date
diagnosis string
customReferenceId string

external prescription no. defaults to #id
prescriber string

uid of prescriber's account
spfddsn string
items object[]
items.id string Default value: auto-generated-id
items.medicalRecordItemId string

reference to medical-records#medication-order#item#id
items.inventoryTransactionItemId string

reference to inventory-transactions#items#id
items.medicine string

reference to medicines#id
items.genericName string
items.brandName string
items.strength number
  • amount of drug in the dosage form

examples (combined with strengthUnit and dosageForm)

  • 500 mg capsule
  • 250 mg/5 mL suspension
items.strengthUnit string

examples

  • mg
items.dosageForm string
  • physical form of a dose of a the drug
items.dosageString string
  • string representation of amount + dosageForm + frequency

examples

  • tablet
  • capsule
  • ointment
  • aerosol
  • patch
  • suspension
  • injection
  • etc.
items.amount number
  • dose
  • specified amount of medication taken at one time
items.route string
  • the way the dosage form is written

examples

  • oral
  • rectal
  • inhalation
  • nasal
  • topical
  • etc.
items.formulation string

string representation/combinations of

  • strength
  • strengthUnit
  • dosageForm
  • route

examples

  • 120 mg/5 mL (125 mg/5 mL) suspension, 30 mL (alcohol-free)
  • 250 mg/5 mL syrup, 30 mL (alcohol-free)
items.frequency string
  • combind with dose (and doseUnit), defines the dosage regimen

examples (combined with dose, doseUnit, optional dosageForm)

  • 2.5 mL twice a day
items.sig string
  • instruction to patient

historically

  • lt. signature
  • to be written by pharmacist in the packaging of the medicine (for recipe)
items.dispense number
  • number of units to be given to the patient
items.dispenseUnit string
  • usually just the same as the dosageForm
items.refills number
  • number of allowed refills for the particular prescription
items.isDangerous boolean
  • flag if the medicine is considered a dangerous drug

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Pharmacy Medication Order - Patch

Back to top

Update pharmacy medication order

PATCH /pharmacy-medication-orders/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional
createdBy string optional
medicalRecordOrder string optional

reference to a patient's medical-records#medication-order
inventoryTransaction string optional

reference to origin inventory-transactions
medicine string optional
issuedAt number optional

defaults to creation date
diagnosis string optional
customReferenceId string optional

external prescription no. defaults to #id
spfddsn string optional
items object[] Size range: 1..
items.id string Default value: auto-generated-id
items.medicalRecordItemId string

reference to medical-records#medication-order#item#id
items.inventoryTransactionItemId string

reference to inventory-transactions#items#id
items.medicine string

reference to medicines#id
items.genericName string
items.brandName string
items.strength number
  • amount of drug in the dosage form

examples (combined with strengthUnit and dosageForm)

  • 500 mg capsule
  • 250 mg/5 mL suspension
items.strengthUnit string

examples

  • mg
items.dosageForm string
  • physical form of a dose of a the drug
items.dosageString string
  • string representation of amount + dosageForm + frequency

examples

  • tablet
  • capsule
  • ointment
  • aerosol
  • patch
  • suspension
  • injection
  • etc.
items.amount number
  • dose
  • specified amount of medication taken at one time
items.route string
  • the way the dosage form is written

examples

  • oral
  • rectal
  • inhalation
  • nasal
  • topical
  • etc.
items.formulation string

string representation/combinations of

  • strength
  • strengthUnit
  • dosageForm
  • route

examples

  • 120 mg/5 mL (125 mg/5 mL) suspension, 30 mL (alcohol-free)
  • 250 mg/5 mL syrup, 30 mL (alcohol-free)
items.frequency string
  • combind with dose (and doseUnit), defines the dosage regimen

examples (combined with dose, doseUnit, optional dosageForm)

  • 2.5 mL twice a day
items.sig string
  • instruction to patient

historically

  • lt. signature
  • to be written by pharmacist in the packaging of the medicine (for recipe)
items.dispense number
  • number of units to be given to the patient
items.dispenseUnit string
  • usually just the same as the dosageForm
items.refills number
  • number of allowed refills for the particular prescription
items.isDangerous boolean
  • flag if the medicine is considered a dangerous drug

Examples

Example usage:

curl "https://yourdomain.com/pharmacy-medication-orders/<pharmacy-medication-order-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "createdAt": 1234567890
  }'

Parameters examples

json - Request-Example

{
  "createdAt": 1234567890
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string

associated organization's (facility) id
medicalRecordOrder string

reference to a patient's medical-records#medication-order
inventoryTransaction string

reference to origin inventory-transactions
medicine string
prescribee string

patient id or personal details id
prescribeeType string Allowed values: patient,personal-details
issuedAt number

defaults to creation date
diagnosis string
customReferenceId string

external prescription no. defaults to #id
prescriber string

uid of prescriber's account
spfddsn string
items object[]
items.id string Default value: auto-generated-id
items.medicalRecordItemId string

reference to medical-records#medication-order#item#id
items.inventoryTransactionItemId string

reference to inventory-transactions#items#id
items.medicine string

reference to medicines#id
items.genericName string
items.brandName string
items.strength number
  • amount of drug in the dosage form

examples (combined with strengthUnit and dosageForm)

  • 500 mg capsule
  • 250 mg/5 mL suspension
items.strengthUnit string

examples

  • mg
items.dosageForm string
  • physical form of a dose of a the drug
items.dosageString string
  • string representation of amount + dosageForm + frequency

examples

  • tablet
  • capsule
  • ointment
  • aerosol
  • patch
  • suspension
  • injection
  • etc.
items.amount number
  • dose
  • specified amount of medication taken at one time
items.route string
  • the way the dosage form is written

examples

  • oral
  • rectal
  • inhalation
  • nasal
  • topical
  • etc.
items.formulation string

string representation/combinations of

  • strength
  • strengthUnit
  • dosageForm
  • route

examples

  • 120 mg/5 mL (125 mg/5 mL) suspension, 30 mL (alcohol-free)
  • 250 mg/5 mL syrup, 30 mL (alcohol-free)
items.frequency string
  • combind with dose (and doseUnit), defines the dosage regimen

examples (combined with dose, doseUnit, optional dosageForm)

  • 2.5 mL twice a day
items.sig string
  • instruction to patient

historically

  • lt. signature
  • to be written by pharmacist in the packaging of the medicine (for recipe)
items.dispense number
  • number of units to be given to the patient
items.dispenseUnit string
  • usually just the same as the dosageForm
items.refills number
  • number of allowed refills for the particular prescription
items.isDangerous boolean
  • flag if the medicine is considered a dangerous drug

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Pharmacy Medication Order - Post

Back to top

Create pharmacy medication order

POST /pharmacy-medication-orders

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
createdAt number optional
createdBy string optional
organization string optional

associated organization's (facility) id
medicalRecordOrder string optional

reference to a patient's medical-records#medication-order
inventoryTransaction string optional

reference to origin inventory-transactions
medicine string optional
prescribee string optional

patient id or personal details id
prescribeeType string optional Allowed values: patient,personal-details
issuedAt number optional

defaults to creation date
diagnosis string optional
customReferenceId string optional

external prescription no. defaults to #id
prescriber string optional

uid of prescriber's account
spfddsn string optional
items object[] Size range: 1..
items.id string Default value: auto-generated-id
items.medicalRecordItemId string

reference to medical-records#medication-order#item#id
items.inventoryTransactionItemId string

reference to inventory-transactions#items#id
items.medicine string

reference to medicines#id
items.genericName string
items.brandName string
items.strength number
  • amount of drug in the dosage form

examples (combined with strengthUnit and dosageForm)

  • 500 mg capsule
  • 250 mg/5 mL suspension
items.strengthUnit string

examples

  • mg
items.dosageForm string
  • physical form of a dose of a the drug
items.dosageString string
  • string representation of amount + dosageForm + frequency

examples

  • tablet
  • capsule
  • ointment
  • aerosol
  • patch
  • suspension
  • injection
  • etc.
items.amount number
  • dose
  • specified amount of medication taken at one time
items.route string
  • the way the dosage form is written

examples

  • oral
  • rectal
  • inhalation
  • nasal
  • topical
  • etc.
items.formulation string

string representation/combinations of

  • strength
  • strengthUnit
  • dosageForm
  • route

examples

  • 120 mg/5 mL (125 mg/5 mL) suspension, 30 mL (alcohol-free)
  • 250 mg/5 mL syrup, 30 mL (alcohol-free)
items.frequency string
  • combind with dose (and doseUnit), defines the dosage regimen

examples (combined with dose, doseUnit, optional dosageForm)

  • 2.5 mL twice a day
items.sig string
  • instruction to patient

historically

  • lt. signature
  • to be written by pharmacist in the packaging of the medicine (for recipe)
items.dispense number
  • number of units to be given to the patient
items.dispenseUnit string
  • usually just the same as the dosageForm
items.refills number
  • number of allowed refills for the particular prescription
items.isDangerous boolean
  • flag if the medicine is considered a dangerous drug

Examples

Example usage:

curl "https://yourdomain.com/pharmacy-medication-orders" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "items": [
      {
        "medicalRecordItemId": "some-medicalRecordItem-id",
        "inventoryTransactionItemId": "some-inventoryTransactionItem-id",
        "medicine": "medicine-id"
      }
    ]
  }'

Parameters examples

json - Request-Example

{
  "items": [
    {
      "medicalRecordItemId": "some-medicalRecordItem-id",
      "inventoryTransactionItemId": "some-inventoryTransactionItem-id",
      "medicine": "medicine-id"
    }
  ]
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number
createdBy string
organization string

associated organization's (facility) id
medicalRecordOrder string

reference to a patient's medical-records#medication-order
inventoryTransaction string

reference to origin inventory-transactions
medicine string
prescribee string

patient id or personal details id
prescribeeType string Allowed values: patient,personal-details
issuedAt number

defaults to creation date
diagnosis string
customReferenceId string

external prescription no. defaults to #id
prescriber string

uid of prescriber's account
spfddsn string
items object[]
items.id string Default value: auto-generated-id
items.medicalRecordItemId string

reference to medical-records#medication-order#item#id
items.inventoryTransactionItemId string

reference to inventory-transactions#items#id
items.medicine string

reference to medicines#id
items.genericName string
items.brandName string
items.strength number
  • amount of drug in the dosage form

examples (combined with strengthUnit and dosageForm)

  • 500 mg capsule
  • 250 mg/5 mL suspension
items.strengthUnit string

examples

  • mg
items.dosageForm string
  • physical form of a dose of a the drug
items.dosageString string
  • string representation of amount + dosageForm + frequency

examples

  • tablet
  • capsule
  • ointment
  • aerosol
  • patch
  • suspension
  • injection
  • etc.
items.amount number
  • dose
  • specified amount of medication taken at one time
items.route string
  • the way the dosage form is written

examples

  • oral
  • rectal
  • inhalation
  • nasal
  • topical
  • etc.
items.formulation string

string representation/combinations of

  • strength
  • strengthUnit
  • dosageForm
  • route

examples

  • 120 mg/5 mL (125 mg/5 mL) suspension, 30 mL (alcohol-free)
  • 250 mg/5 mL syrup, 30 mL (alcohol-free)
items.frequency string
  • combind with dose (and doseUnit), defines the dosage regimen

examples (combined with dose, doseUnit, optional dosageForm)

  • 2.5 mL twice a day
items.sig string
  • instruction to patient

historically

  • lt. signature
  • to be written by pharmacist in the packaging of the medicine (for recipe)
items.dispense number
  • number of units to be given to the patient
items.dispenseUnit string
  • usually just the same as the dosageForm
items.refills number
  • number of allowed refills for the particular prescription
items.isDangerous boolean
  • flag if the medicine is considered a dangerous drug

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""