Jump to

• Request
• Response

Get a list of medication dispenses

get

/MedicationDispense

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of medication dispenses that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• patient: string
  The patient who the dispenses are for.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/MedicationDispense"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/MedicationDispense"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object MedicationDispense
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/MedicationDispense"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : MedicationDispense

Type: object

Show Source

• authorizingPrescription: array authorizingPrescription
  (USCDI) The medication order that authorizes the dispense.
• dosageInstruction: array dosageInstruction
  (USCDI) How the medication is to be used by the patient or administered by the caregiver.
• id(required): string
• medicationCodeableConcept(required): medicationCodeableConcept
  (USCDI) What medication was supplied.
• performer: array performer
  (USCDI) The individual who performed the event.
• quantity: quantity
  (USCDI) The amount dispensed.
• resourceType(required): string
  Allowed Values: [ "MedicationDispense" ]
• status(required): string
  (USCDI) The following values are supported:

  • preparation
  • in-progress
  • cancelled
  • on-hold
  • completed
  • entered-in-error
  • stopped
  • declined
  • unknown
• subject(required): subject
  (USCDI) Who the dispense is for.
• type: type
  (USCDI) A trial fill, partial fill, emergency fill, and so on.
• whenHandedOver: string (date-time)
  (USCDI) When the product was given out or mailed.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "medicationCodeableConcept",
        "subject"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "MedicationDispense"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>preparation</code></li>\n    <li><code>in-progress</code></li>\n    <li><code>cancelled</code></li>\n    <li><code>on-hold</code></li>\n    <li><code>completed</code></li>\n    <li><code>entered-in-error</code></li>\n    <li><code>stopped</code></li>\n    <li><code>declined</code></li>\n    <li><code>unknown</code></li>\n  </ul>\n"
        },
        "medicationCodeableConcept":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) What medication was supplied."
        },
        "subject":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) Who the dispense is for."
        },
        "performer":{
            "type":"array",
            "description":"(USCDI) The individual who performed the event.",
            "items":{
                "$ref":"#/components/schemas/MedicationDispensePerformer"
            }
        },
        "authorizingPrescription":{
            "type":"array",
            "description":"(USCDI) The medication order that authorizes the dispense.",
            "items":{
                "$ref":"#/components/schemas/Reference"
            }
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) A trial fill, partial fill, emergency fill, and so on."
        },
        "quantity":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Quantity"
                }
            ],
            "description":"(USCDI) The amount dispensed."
        },
        "whenHandedOver":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) When the product was given out or mailed."
        },
        "dosageInstruction":{
            "type":"array",
            "description":"(USCDI) How the medication is to be used by the patient or administered by the caregiver.",
            "items":{
                "$ref":"#/components/schemas/Dosage"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : authorizingPrescription

Type: array

(USCDI) The medication order that authorizes the dispense.

Show Source

• Array of: object Reference

{
    "type":"array",
    "description":"(USCDI) The medication order that authorizes the dispense.",
    "items":{
        "$ref":"#/components/schemas/Reference"
    }
}

Nested Schema : dosageInstruction

Type: array

(USCDI) How the medication is to be used by the patient or administered by the caregiver.

Show Source

• Array of: object Dosage

{
    "type":"array",
    "description":"(USCDI) How the medication is to be used by the patient or administered by the caregiver.",
    "items":{
        "$ref":"#/components/schemas/Dosage"
    }
}

Nested Schema : medicationCodeableConcept

(USCDI) What medication was supplied.

Match All

(USCDI) What medication was supplied.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) What medication was supplied."
}

Nested Schema : performer

Type: array

(USCDI) The individual who performed the event.

Show Source

• Array of: object MedicationDispensePerformer

{
    "type":"array",
    "description":"(USCDI) The individual who performed the event.",
    "items":{
        "$ref":"#/components/schemas/MedicationDispensePerformer"
    }
}

Nested Schema : quantity

(USCDI) The amount dispensed.

Match All

(USCDI) The amount dispensed.

Show Source

• object Quantity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Quantity"
        }
    ],
    "description":"(USCDI) The amount dispensed."
}

Nested Schema : subject

(USCDI) Who the dispense is for.

Match All

(USCDI) Who the dispense is for.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) Who the dispense is for."
}

Nested Schema : type

(USCDI) A trial fill, partial fill, emergency fill, and so on.

Match All

(USCDI) A trial fill, partial fill, emergency fill, and so on.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) A trial fill, partial fill, emergency fill, and so on."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : Dosage

Type: object

Show Source

• doseAndRate: array doseAndRate
  (USCDI) The amount of medication administered.
• text: string
  (USCDI) The free-text dosage instructions, for example, SIG.
• timing: object timing
  (USCDI) When the medication should be administered.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"(USCDI) The free-text dosage instructions, for example, SIG."
        },
        "timing":{
            "type":"object",
            "description":"(USCDI) When the medication should be administered."
        },
        "doseAndRate":{
            "type":"array",
            "description":"(USCDI) The amount of medication administered.",
            "items":{
                "$ref":"#/components/schemas/DosageDoseAndRate"
            }
        }
    }
}

Nested Schema : doseAndRate

Type: array

(USCDI) The amount of medication administered.

Show Source

• Array of: object DosageDoseAndRate

{
    "type":"array",
    "description":"(USCDI) The amount of medication administered.",
    "items":{
        "$ref":"#/components/schemas/DosageDoseAndRate"
    }
}

Nested Schema : timing

Type: object

(USCDI) When the medication should be administered.

Nested Schema : DosageDoseAndRate

Type: object

Show Source

• doseQuantity: doseQuantity
  (USCDI) The amount of medication per dose.

{
    "type":"object",
    "properties":{
        "doseQuantity":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Quantity"
                }
            ],
            "description":"(USCDI) The amount of medication per dose."
        }
    }
}

Nested Schema : doseQuantity

(USCDI) The amount of medication per dose.

Match All

(USCDI) The amount of medication per dose.

Show Source

• object Quantity

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Quantity"
        }
    ],
    "description":"(USCDI) The amount of medication per dose."
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• system: string (uri)
• unit: string
• value: number

{
    "type":"object",
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string"
        },
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : MedicationDispensePerformer

Type: object

Show Source

• actor(required): actor
  (USCDI) The individual who was performing the dispense.

{
    "type":"object",
    "required":[
        "actor"
    ],
    "properties":{
        "actor":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The individual who was performing the dispense."
        }
    }
}

Nested Schema : actor

(USCDI) The individual who was performing the dispense.

Match All

(USCDI) The individual who was performing the dispense.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The individual who was performing the dispense."
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top