Jump to

• Request
• Response

Get a medication dispense by ID

get

/MedicationDispense/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual medication dispense by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful retrieve response.

Body ()

Root Schema : MedicationDispense

Type: object

A record of medication supplied to a patient.

Show Source

• authorizingPrescription: array authorizingPrescription
  The prescriptions authorizing the dispense.
• dosageInstruction: array dosageInstruction
  How the medication should be used.
• id(required): string
  The logical ID of the dispense.
• medicationCodeableConcept: object CodeableConcept
• medicationReference: object ReferenceForMedicationDispense
• meta: object meta
• performer: array performer
  The actors involved in dispensing.
• quantity: object Quantity
• resourceType(required): string
  Allowed Values: [ "MedicationDispense" ]
• status(required): string
  Allowed Values: [ "preparation", "in-progress", "cancelled", "on-hold", "completed", "entered-in-error", "stopped", "declined", "unknown" ]

  The current dispense status.
• subject(required): object ReferenceForMedicationDispense
• type: object CodeableConcept
• whenHandedOver: string (date-time)
  When the medication was provided.

{
    "type":"object",
    "description":"A record of medication supplied to a patient.",
    "required":[
        "resourceType",
        "id",
        "status",
        "subject"
    ],
    "additionalProperties":false,
    "oneOf":[
        {
            "required":[
                "medicationReference"
            ]
        },
        {
            "required":[
                "medicationCodeableConcept"
            ]
        }
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "MedicationDispense"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the dispense."
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string",
                    "description":"The version-specific identifier."
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The last update time."
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "preparation",
                "in-progress",
                "cancelled",
                "on-hold",
                "completed",
                "entered-in-error",
                "stopped",
                "declined",
                "unknown"
            ],
            "description":"The current dispense status."
        },
        "medicationReference":{
            "$ref":"#/components/schemas/ReferenceForMedicationDispense"
        },
        "medicationCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForMedicationDispense"
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PerformerForMedicationDispense"
            },
            "description":"The actors involved in dispensing."
        },
        "authorizingPrescription":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForMedicationDispense"
            },
            "description":"The prescriptions authorizing the dispense."
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "quantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "whenHandedOver":{
            "type":"string",
            "format":"date-time",
            "description":"When the medication was provided."
        },
        "dosageInstruction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Dosage"
            },
            "description":"How the medication should be used."
        }
    }
}

Match One Schema

Show Source

{
    "type":"object",
    "description":"A record of medication supplied to a patient.",
    "required":[
        "resourceType",
        "id",
        "status",
        "subject"
    ],
    "additionalProperties":false,
    "oneOf":[
        {
            "required":[
                "medicationReference"
            ]
        },
        {
            "required":[
                "medicationCodeableConcept"
            ]
        }
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "MedicationDispense"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the dispense."
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string",
                    "description":"The version-specific identifier."
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The last update time."
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "preparation",
                "in-progress",
                "cancelled",
                "on-hold",
                "completed",
                "entered-in-error",
                "stopped",
                "declined",
                "unknown"
            ],
            "description":"The current dispense status."
        },
        "medicationReference":{
            "$ref":"#/components/schemas/ReferenceForMedicationDispense"
        },
        "medicationCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForMedicationDispense"
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PerformerForMedicationDispense"
            },
            "description":"The actors involved in dispensing."
        },
        "authorizingPrescription":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForMedicationDispense"
            },
            "description":"The prescriptions authorizing the dispense."
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "quantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "whenHandedOver":{
            "type":"string",
            "format":"date-time",
            "description":"When the medication was provided."
        },
        "dosageInstruction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Dosage"
            },
            "description":"How the medication should be used."
        }
    }
}

Nested Schema : authorizingPrescription

Type: array

The prescriptions authorizing the dispense.

Show Source

• Array of: object ReferenceForMedicationDispense

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForMedicationDispense"
    },
    "description":"The prescriptions authorizing the dispense."
}

Nested Schema : dosageInstruction

Type: array

How the medication should be used.

Show Source

• Array of: object Dosage

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Dosage"
    },
    "description":"How the medication should be used."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : ReferenceForMedicationDispense

Type: object

Show Source

• display: string
  The human-readable reference label.
• extension: array extension
  The additional reference information.
• reference: string
  The relative resource reference.

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string",
            "description":"The relative resource reference."
        },
        "display":{
            "type":"string",
            "description":"The human-readable reference label."
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForMedicationDispense"
            },
            "description":"The additional reference information."
        }
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
  The last update time.
• security: array security
• versionId: string
  The version-specific identifier.

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string",
            "description":"The version-specific identifier."
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The last update time."
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : performer

Type: array

The actors involved in dispensing.

Show Source

• Array of: object PerformerForMedicationDispense

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PerformerForMedicationDispense"
    },
    "description":"The actors involved in dispensing."
}

Nested Schema : Quantity

Type: object

Show Source

• code: string
• comparator: string
• system: string
• unit: string
• value: number

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

Nested Schema : Dosage

Type: object

Show Source

• additionalInstruction: array additionalInstruction
• asNeededBoolean: boolean
• asNeededCodeableConcept: object CodeableConcept
• doseAndRate: array doseAndRate
  The dose details.
• patientInstruction: string
• route: object CodeableConcept
• site: object CodeableConcept
• text: string
  The free-text dosage instruction.
• timing: object Timing

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"The free-text dosage instruction."
        },
        "additionalInstruction":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "patientInstruction":{
            "type":"string"
        },
        "timing":{
            "$ref":"#/components/schemas/Timing"
        },
        "asNeededBoolean":{
            "type":"boolean"
        },
        "asNeededCodeableConcept":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "site":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "route":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "doseAndRate":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DoseAndRate"
            },
            "description":"The dose details."
        }
    }
}

Nested Schema : additionalInstruction

Type: array

Show Source

• Array of: object CodeableConcept

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

Nested Schema : doseAndRate

Type: array

The dose details.

Show Source

• Array of: object DoseAndRate

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DoseAndRate"
    },
    "description":"The dose details."
}

Nested Schema : Timing

Type: object

Show Source

• code: object CodeableConcept
• repeat: object TimingRepeat

{
    "type":"object",
    "properties":{
        "repeat":{
            "$ref":"#/components/schemas/TimingRepeat"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    }
}

Nested Schema : DoseAndRate

Type: object

Show Source

• doseQuantity: object Quantity
• rateQuantity: object Quantity

{
    "type":"object",
    "properties":{
        "doseQuantity":{
            "$ref":"#/components/schemas/Quantity"
        },
        "rateQuantity":{
            "$ref":"#/components/schemas/Quantity"
        }
    }
}

Nested Schema : TimingRepeat

Type: object

Show Source

• boundsPeriod: object Period
• count: integer
• duration: number
• durationUnit: string
• when: array when

{
    "type":"object",
    "properties":{
        "boundsPeriod":{
            "$ref":"#/components/schemas/Period"
        },
        "count":{
            "type":"integer"
        },
        "duration":{
            "type":"number"
        },
        "durationUnit":{
            "type":"string"
        },
        "when":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : when

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : extension

Type: array

The additional reference information.

Show Source

• Array of: object ExtensionForMedicationDispense

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForMedicationDispense"
    },
    "description":"The additional reference information."
}

Nested Schema : ExtensionForMedicationDispense

Type: object

Show Source

• url: string (uri)
  The extension definition URL.
• valueCode: string
  The coded extension value.

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "url":{
            "type":"string",
            "format":"uri",
            "description":"The extension definition URL."
        },
        "valueCode":{
            "type":"string",
            "description":"The coded extension value."
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

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

Nested Schema : PerformerForMedicationDispense

Type: object

Show Source

• actor: object ReferenceForMedicationDispense

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "actor":{
            "$ref":"#/components/schemas/ReferenceForMedicationDispense"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top