xCaliber healthCare Data Mesh

Medication

Overview

The Medication API enables healthcare applications to seamlessly integrate comprehensive prescription drug data and pharmacy benefits information. Developers can build solutions for checking drug coverage eligibility, pricing, drug interactions, managing prescriptions, and more to improve medication management and adherence.

Use Cases

  • Prescription Management - Build applications to electronically prescribe and renew medications while integrating with pharmacy systems.
  • Medication Reconciliation - Create tools to consolidate medication lists from multiple sources into a single patient profile for improved accuracy.
  • Drug Databases - Develop up-to-date databases of medications with details like formulations, strengths, packaging, national drug codes etc.
  • Drug Interaction Checking - Implement real-time drug-drug and drug-allergy interaction analysis to improve medication safety.
  • Inventory Management - Design interfaces to EHRs and pharmacy systems to track medication inventory levels and automate reordering.
  • Medication Adherence - Build apps with reminder alerts for patients to take their medications on time and as prescribed.
  • Clinical Decision Support - Integrate drug reference data to provide dosing assistance, contraindications, precautions at point-of-prescribing.
  • Analytics and Reporting - Generate insights regarding medication prescribing patterns and utilization across patient populations.

EHR Data Model

EHRSupported?Mapped Source Object
Athena
Elation
Epic

Object Definition

{
  "resourceType": "Medication",
  "id": "medicationexample1",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Amoxicillin 250mg/5ml Suspension</div>"
  },
  "code": {
    "text": "Amoxicillin 250mg/5ml Suspension"
  },
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data FieldTypeDescription
resourceTypeMedicationThis is a Medication resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedBackboneElementThese 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.
extensionExtensionMay 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.
modifierExtensionExtensionMay 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).
identifierIdentifierBusiness identifier for this medication.
codeCodeableConceptA code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.
statuscodeA code to indicate if the medication is in active use.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
formCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
amountRatioSpecific amount of the drug in the packaged product. For example, when specifying a product that has the same strength (For example, Insulin glargine 100 unit per mL solution for injection), this attribute provides additional clarification of the package amount (For example, 3 mL, 10mL, etc.).
ingredientBackboneElementIdentifies a particular constituent of interest in the product.
ingredient.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ingredient.extensionExtensionMay 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.
ingredient.modifierExtensionExtensionMay 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).
ingredient.itemCodeableConceptCodeableConceptThe actual ingredient - either a substance (simple ingredient) or another medication of a medication.
ingredient.itemReferenceReferenceThe actual ingredient - either a substance (simple ingredient) or another medication of a medication.
ingredient.isActivebooleanIndication of whether this ingredient affects the therapeutic action of the drug.
ingredient.strengthRatioSpecifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.
batchBackboneElementInformation that only applies to packages (not products).
batch.idstringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
batch.extensionExtensionMay 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.
batch.modifierExtensionExtensionMay 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).
batch.lotNumberstringThe assigned lot number of a batch of the specified product.
batch.expirationDatedateTimeWhen this specific batch of product will expire.

Extensions

NameURL

Operations & APIs

Medication-GET

Medication-POST

Medication ID-GET

Medication ID-PUT

Medication ID-DELETE