# Get FHIR r4 medication dispense by ID Endpoint: GET /site/{siteId}/fhir/medication-dispense/{id} Version: 1.0 Security: bearer, bearer ## Path parameters: - `id` (string, required) ID of the MedicationDispense - `siteId` (string, required) Site identifier ## Response 200 fields (application/json): - `resourceType` (any, required) This is a MedicationDispense resource Enum: "MedicationDispense" - `id` (string) Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive. Example: "example-id" - `meta` (object) The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. - `meta.id` (string) An extension object type #string. Example: "example-string" - `meta.extension` (array) May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. - `meta.versionId` (object) An extension object type #id. - `meta._versionId` (object) An extension object type #Element. - `meta.lastUpdated` (object) An extension object type #instant. - `meta._lastUpdated` (object) An extension object type #Element. - `meta.source` (string) An extension object type #uri. Example: "https://example.org/resource" - `meta._source` (object) An extension object type #Element. - `meta.profile` (array) A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Example: ["http://example.org/Profile"] - `meta.security` (array) Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. - `meta.tag` (array) Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. - `implicitRules` (string) String of characters used to identify a name or a resource Example: "https://example.org/resource" - `_implicitRules` (object) Base definition for all elements in a resource. - `language` (string) A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents Example: "sample-code" - `_language` (object) Base definition for all elements in a resource. - `text` (object) A human-readable summary of the resource conveying the essential clinical and business information for the resource. - `text.status` (any) The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. Enum: "generated", "extensions", "additional", "empty" - `text._status` (object) An extension object type #Element. - `text.div` (string, required) An extension object type #xhtml. Example: "
Example
" - `contained` (array) These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. - `extension` (array) May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Example: [{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-category","valueString":"Clinical.Medications"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status","valueCode":"trial-use"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm","valueInteger":2},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category","valueCode":"patient"},{"url":"http://hl7.org/fhir/StructureDefinition/structuredefinition-wg","valueCode":"phx"}] - `extension.url` (string) An extension object type #uri. Example: "https://example.org/resource" - `extension._url` (object) An extension object type #Element. - `extension.valueBase64Binary` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "U2FtcGxl" - `extension._valueBase64Binary` (object) An extension object type #Element. - `extension.valueBoolean` (boolean) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: true - `extension._valueBoolean` (object) An extension object type #Element. - `extension.valueCanonical` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "http://example.org/Profile" - `extension._valueCanonical` (object) An extension object type #Element. - `extension.valueCode` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "sample-code" - `extension._valueCode` (object) An extension object type #Element. - `extension.valueDate` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01" - `extension._valueDate` (object) An extension object type #Element. - `extension.valueDateTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueDateTime` (object) An extension object type #Element. - `extension.valueDecimal` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1.23 - `extension._valueDecimal` (object) An extension object type #Element. - `extension.valueId` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-id" - `extension._valueId` (object) An extension object type #Element. - `extension.valueInstant` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "2024-01-01T00:00:00Z" - `extension._valueInstant` (object) An extension object type #Element. - `extension.valueInteger` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valueInteger` (object) An extension object type #Element. - `extension.valueMarkdown` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "Sample markdown text" - `extension._valueMarkdown` (object) An extension object type #Element. - `extension.valueOid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:oid:1.2.3.4.5" - `extension._valueOid` (object) An extension object type #Element. - `extension.valuePositiveInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: 1 - `extension._valuePositiveInt` (object) An extension object type #Element. - `extension.valueString` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "example-string" - `extension._valueString` (object) An extension object type #Element. - `extension.valueTime` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "12:00:00" - `extension._valueTime` (object) An extension object type #Element. - `extension.valueUnsignedInt` (number) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). - `extension._valueUnsignedInt` (object) An extension object type #Element. - `extension.valueUri` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org/resource" - `extension._valueUri` (object) An extension object type #Element. - `extension.valueUrl` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "https://example.org" - `extension._valueUrl` (object) An extension object type #Element. - `extension.valueUuid` (string) Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list). Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000" - `extension._valueUuid` (object) An extension object type #Element. - `extension.valueAddress` (object) An extension object type #Address. - `extension.valueAge` (object) An extension object type #Age. - `extension.valueAnnotation` (object) An extension object type #Annotation. - `extension.valueAttachment` (object) An extension object type #Attachment. - `extension.valueCodeableConcept` (object) An extension object type #CodeableConcept. - `extension.valueCoding` (object) An extension object type #Coding. - `extension.valueContactPoint` (object) An extension object type #ContactPoint. - `extension.valueCount` (object) An extension object type #Count. - `extension.valueDistance` (object) An extension object type #Distance. - `extension.valueDuration` (object) An extension object type #Duration. - `extension.valueHumanName` (object) An extension object type #HumanName. - `extension.valueIdentifier` (object) An extension object type #Identifier. - `extension.valueMoney` (object) An extension object type #Money. - `extension.valuePeriod` (object) An extension object type #Period. - `extension.valueQuantity` (object) An extension object type #Quantity. - `extension.valueRange` (object) An extension object type #Range. - `extension.valueRatio` (object) An extension object type #Ratio. - `extension.valueReference` (object) An extension object type #Reference. - `extension.valueSampledData` (object) An extension object type #SampledData. - `extension.valueSignature` (object) An extension object type #Signature. - `extension.valueTiming` (object) An extension object type #Timing. - `extension.valueContactDetail` (object) An extension object type #ContactDetail. - `extension.valueContributor` (object) An extension object type #Contributor. - `extension.valueDataRequirement` (object) An extension object type #DataRequirement. - `extension.valueExpression` (object) An extension object type #Expression. - `extension.valueParameterDefinition` (object) An extension object type #ParameterDefinition. - `extension.valueRelatedArtifact` (object) An extension object type #RelatedArtifact. - `extension.valueTriggerDefinition` (object) An extension object type #TriggerDefinition. - `extension.valueUsageContext` (object) An extension object type #UsageContext. - `extension.valueDosage` (object) An extension object type #Dosage. - `extension.valueMeta` (object) An extension object type #Meta. - `modifierExtension` (array) May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). - `identifier` (array) Identifiers associated with this Medication Dispense that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server. - `identifier.use` (any) The purpose of this identifier. Enum: "usual", "official", "temp", "secondary", "old" - `identifier._use` (object) An extension object type #Element. - `identifier.type` (object) An extension object type #CodeableConcept. - `identifier.system` (string) An extension object type #uri. Example: "https://example.org/resource" - `identifier._system` (object) An extension object type #Element. - `identifier.value` (string) An extension object type #string. Example: "example-string" - `identifier._value` (object) An extension object type #Element. - `identifier.period` (object) An extension object type #Period. - `identifier.assigner` (object) An extension object type #Reference. - `partOf` (array) The procedure that trigger the dispense. - `partOf.reference` (string) An extension object type #string. Example: "example-string" - `partOf._reference` (object) An extension object type #Element. - `partOf.type` (string) An extension object type #uri. Example: "https://example.org/resource" - `partOf._type` (object) An extension object type #Element. - `partOf.identifier` (object) An extension object type #Identifier. - `partOf.display` (string) An extension object type #string. Example: "example-string" - `partOf._display` (object) An extension object type #Element. - `status` (string) A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents Example: "sample-code" - `_status` (object) Base definition for all elements in a resource. - `statusReasonCodeableConcept` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `statusReasonCodeableConcept.coding` (array) A reference to a code defined by a terminology system. - `statusReasonCodeableConcept.text` (string) An extension object type #string. Example: "example-string" - `statusReasonCodeableConcept._text` (object) An extension object type #Element. - `statusReasonReference` (object) A reference from one resource to another. - `category` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `medicationCodeableConcept` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `medicationReference` (object) A reference from one resource to another. - `subject` (object) A reference from one resource to another. - `context` (object) A reference from one resource to another. - `supportingInformation` (array) Additional information that supports the medication being dispensed. - `performer` (array) Indicates who or what performed the event. - `performer.modifierExtension` (array) May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). - `performer.function` (object) An extension object type #CodeableConcept. - `performer.actor` (object, required) An extension object type #Reference. - `location` (object) A reference from one resource to another. - `authorizingPrescription` (array) Indicates the medication order that is being dispensed against. - `type` (object) A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. - `quantity` (object) A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. - `quantity.value` (number) An extension object type #decimal. Example: 1.23 - `quantity.comparator` (any) How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value. Enum: "<", "<=", ">=", ">" - `quantity._comparator` (object) An extension object type #Element. - `quantity.unit` (string) An extension object type #string. Example: "example-string" - `quantity._unit` (object) An extension object type #Element. - `quantity.code` (string) An extension object type #code. Example: "sample-code" - `quantity._code` (object) An extension object type #Element. - `daysSupply` (object) A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies. - `whenPrepared` (string) A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. Example: "2024-01-01T00:00:00Z" - `_whenPrepared` (object) Base definition for all elements in a resource. - `whenHandedOver` (string) A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates. Example: "2024-01-01T00:00:00Z" - `_whenHandedOver` (object) Base definition for all elements in a resource. - `destination` (object) A reference from one resource to another. - `receiver` (array) Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional. - `note` (array) Extra information about the dispense that could not be conveyed in the other attributes. - `note.authorReference` (object) An extension object type #Reference. - `note.authorString` (string) The individual responsible for making the annotation. Example: "example-string" - `note._authorString` (object) An extension object type #Element. - `note.time` (string) An extension object type #dateTime. Example: "2024-01-01T00:00:00Z" - `note._time` (object) An extension object type #Element. - `note.text` (object) An extension object type #markdown. - `dosageInstruction` (array) Indicates how the medication is to be used by the patient. - `dosageInstruction.sequence` (integer) An extension object type #integer. Example: 1 - `dosageInstruction._sequence` (object) An extension object type #Element. - `dosageInstruction.additionalInstruction` (array) Supplemental instructions to the patient on how to take the medication (e.g. "with meals" or"take half to one hour before food") or warnings for the patient about the medication (e.g. "may cause drowsiness" or "avoid exposure of skin to direct sunlight or sunlamps"). - `dosageInstruction.patientInstruction` (string) An extension object type #string. Example: "example-string" - `dosageInstruction._patientInstruction` (object) An extension object type #Element. - `dosageInstruction.timing` (object) An extension object type #Timing. - `dosageInstruction.asNeededBoolean` (boolean) Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept). Example: true - `dosageInstruction._asNeededBoolean` (object) An extension object type #Element. - `dosageInstruction.asNeededCodeableConcept` (object) An extension object type #CodeableConcept. - `dosageInstruction.site` (object) An extension object type #CodeableConcept. - `dosageInstruction.route` (object) An extension object type #CodeableConcept. - `dosageInstruction.method` (object) An extension object type #CodeableConcept. - `dosageInstruction.doseAndRate` (array) The amount of medication administered. - `dosageInstruction.maxDosePerPeriod` (object) An extension object type #Ratio. - `dosageInstruction.maxDosePerAdministration` (object) An extension object type #Quantity. - `dosageInstruction.maxDosePerLifetime` (object) An extension object type #Quantity. - `substitution` (object) Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order. - `substitution.wasSubstituted` (boolean) An extension object type #boolean. Example: true - `substitution._wasSubstituted` (object) An extension object type #Element. - `substitution.reason` (array) Indicates the reason for the substitution (or lack of substitution) from what was prescribed. - `substitution.responsibleParty` (array) The person or organization that has primary responsibility for the substitution. - `detectedIssue` (array) Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. drug-drug interaction, duplicate therapy, dosage alert etc. - `eventHistory` (array) A summary of the events of interest that have occurred, such as when the dispense was verified. ## Response 401 fields (application/json): - `message` (string, required) Error message indicating unauthorized access. Example: "Unauthorized" - `statusCode` (number, required) HTTP status code for unauthorized access. Example: 401 ## Response 400 fields ## Response 404 fields