MedicationKnowledge - FHIR Resource (r4)
This MedicationKnowledge Resource uses the FHIR API standard for access and structure.
Validate an MedicationKnowledge FHIR Resource (r4)
MedicationKnowledge Attributes
AttributeField is listTypeDescription
Description: Code that identifies this medication
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/ndc",
"code": "0069-2587-10",
"display": "Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)"
}
]
}Learn more about the (MedicationKnowledge) code FHIR attribute
Description: active | inactive | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (MedicationKnowledge) status FHIR attribute
Description: Manufacturer of the item
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufacturer": {
"reference": "#org4"
}Learn more about the (MedicationKnowledge) manufacturer FHIR attribute
Description: powder | tablets | capsule +
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doseForm": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385219001",
"display": "Injection Solution (qualifier value)"
}
]
}Learn more about the (MedicationKnowledge) doseForm FHIR attribute
Description: Amount of drug in package
FHIR Version: r4
Attribute Type : SimpleQuantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"amount": {
"value": 50,
"unit": "mg/ml"
}Learn more about the (MedicationKnowledge) amount FHIR attribute
Description: Additional names for a medication
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"synonym": [
"Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)"
]Learn more about the (MedicationKnowledge) synonym FHIR attribute
Description: Associated or related medication information
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"relatedMedicationKnowledge": Learn more about the (MedicationKnowledge) relatedMedicationKnowledge FHIR attribute
Description: A medication resource that is associated with this medication
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"associatedMedication": Learn more about the (MedicationKnowledge) associatedMedication FHIR attribute
Description: Category of the medication or product
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"productType": Learn more about the (MedicationKnowledge) productType FHIR attribute
Description: Associated documentation about the medication
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"monograph": Learn more about the (MedicationKnowledge) monograph FHIR attribute
Description: Active or inactive ingredient
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"ingredient": Learn more about the (MedicationKnowledge) ingredient FHIR attribute
Description: The instructions for preparing the medication
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"preparationInstruction": Learn more about the (MedicationKnowledge) preparationInstruction FHIR attribute
Description: The intended or approved route of administration
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intendedRoute": Learn more about the (MedicationKnowledge) intendedRoute FHIR attribute
Description: The pricing of the medication
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"cost": Learn more about the (MedicationKnowledge) cost FHIR attribute
Description: Program under which a medication is reviewed
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"monitoringProgram": Learn more about the (MedicationKnowledge) monitoringProgram FHIR attribute
Description: Guidelines for administration of the medication
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"administrationGuidelines": Learn more about the (MedicationKnowledge) administrationGuidelines FHIR attribute
Description: Categorization of the medication within a formulary or classification system
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"medicineClassification": Learn more about the (MedicationKnowledge) medicineClassification FHIR attribute
Description: Details about packaged medications
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"packaging": Learn more about the (MedicationKnowledge) packaging FHIR attribute
Description: Specifies descriptive properties of the medicine
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"drugCharacteristic": Learn more about the (MedicationKnowledge) drugCharacteristic FHIR attribute
Description: Potential clinical issue with or between medication(s)
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contraindication": Learn more about the (MedicationKnowledge) contraindication FHIR attribute
Description: Regulatory information about a medication
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"regulatory": Learn more about the (MedicationKnowledge) regulatory FHIR attribute
Description: The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"kinetics": Learn more about the (MedicationKnowledge) kinetics FHIR attribute
MedicationKnowledge Example
{
"resourceType": "MedicationKnowledge",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>contained</b>: </p><p><b>code</b>: Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE) <span>(Details : {http://hl7.org/fhir/sid/ndc code '0069-2587-10' = 'n/a', given as 'Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)'})</span></p><p><b>status</b>: active</p><p><b>manufacturer</b>: id: org4; name: Pfizer Laboratories Div Pfizer Inc</p><p><b>doseForm</b>: Injection Solution (qualifier value) <span>(Details : {SNOMED CT code '385219001' = 'Injection solution', given as 'Injection Solution (qualifier value)'})</span></p><p><b>amount</b>: 50 mg/ml</p><p><b>synonym</b>: Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)</p></div>"
},
"contained": [
{
"resourceType": "Organization",
"id": "org4",
"name": "Pfizer Laboratories Div Pfizer Inc"
}
],
"code": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/ndc",
"code": "0069-2587-10",
"display": "Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)"
}
]
},
"status": "active",
"manufacturer": {
"reference": "#org4"
},
"doseForm": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385219001",
"display": "Injection Solution (qualifier value)"
}
]
},
"amount": {
"value": 50,
"unit": "mg/ml"
},
"synonym": [
"Vancomycin Hydrochloride (VANCOMYCIN HYDROCHLORIDE)"
]
}MedicationKnowledge Structure
{
"resourceType" : "MedicationKnowledge",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"code" : { CodeableConcept }, // Code that identifies this medication
"status" : "<code>", // active | inactive | entered-in-error
"manufacturer" : { Reference(Organization) }, // Manufacturer of the item
"doseForm" : { CodeableConcept }, // powder | tablets | capsule +
"amount" : { Quantity(SimpleQuantity) }, // Amount of drug in package
"synonym" : ["<string>"], // Additional names for a medication
"relatedMedicationKnowledge" : [{ // Associated or related medication information
"type" : { CodeableConcept }, // R! Category of medicationKnowledge
"reference" : [{ Reference(MedicationKnowledge) }] // R! Associated documentation about the associated medication knowledge
}],
"associatedMedication" : [{ Reference(Medication) }], // A medication resource that is associated with this medication
"productType" : [{ CodeableConcept }], // Category of the medication or product
"monograph" : [{ // Associated documentation about the medication
"type" : { CodeableConcept }, // The category of medication document
"source" : { Reference(DocumentReference|Media) } // Associated documentation about the medication
}],
"ingredient" : [{ // Active or inactive ingredient
// item[x]: Medication(s) or substance(s) contained in the medication. One of these 2:
"itemCodeableConcept" : { CodeableConcept },
"itemReference" : { Reference(Substance) },
"isActive" : <boolean>, // Active ingredient indicator
"strength" : { Ratio } // Quantity of ingredient present
}],
"preparationInstruction" : "<markdown>", // The instructions for preparing the medication
"intendedRoute" : [{ CodeableConcept }], // The intended or approved route of administration
"cost" : [{ // The pricing of the medication
"type" : { CodeableConcept }, // R! The category of the cost information
"source" : "<string>", // The source or owner for the price information
"cost" : { Money } // R! The price of the medication
}],
"monitoringProgram" : [{ // Program under which a medication is reviewed
"type" : { CodeableConcept }, // Type of program under which the medication is monitored
"name" : "<string>" // Name of the reviewing program
}],
"administrationGuidelines" : [{ // Guidelines for administration of the medication
"dosage" : [{ // Dosage for the medication for the specific guidelines
"type" : { CodeableConcept }, // R! Type of dosage
"dosage" : [{ Dosage }] // R! Dosage for the medication for the specific guidelines
}],
// indication[x]: Indication for use that apply to the specific administration guidelines. One of these 2:
"indicationCodeableConcept" : { CodeableConcept },
"indicationReference" : { Reference(ObservationDefinition) },
"patientCharacteristics" : [{ // Characteristics of the patient that are relevant to the administration guidelines
// characteristic[x]: Specific characteristic that is relevant to the administration guideline. One of these 2:
"characteristicCodeableConcept" : { CodeableConcept },
"characteristicQuantity" : { Quantity(SimpleQuantity) },
"value" : ["<string>"] // The specific characteristic
}]
}],
"medicineClassification" : [{ // Categorization of the medication within a formulary or classification system
"type" : { CodeableConcept }, // R! The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
"classification" : [{ CodeableConcept }] // Specific category assigned to the medication
}],
"packaging" : { // Details about packaged medications
"type" : { CodeableConcept }, // A code that defines the specific type of packaging that the medication can be found in
"quantity" : { Quantity(SimpleQuantity) } // The number of product units the package would contain if fully loaded
},
"drugCharacteristic" : [{ // Specifies descriptive properties of the medicine
"type" : { CodeableConcept }, // Code specifying the type of characteristic of medication
// value[x]: Description of the characteristic. One of these 4:
"valueCodeableConcept" : { CodeableConcept }
"valueString" : "<string>"
"valueQuantity" : { Quantity(SimpleQuantity) }
"valueBase64Binary" : "<base64Binary>"
}],
"contraindication" : [{ Reference(DetectedIssue) }], // Potential clinical issue with or between medication(s)
"regulatory" : [{ // Regulatory information about a medication
"regulatoryAuthority" : { Reference(Organization) }, // R! Specifies the authority of the regulation
"substitution" : [{ // Specifies if changes are allowed when dispensing a medication from a regulatory perspective
"type" : { CodeableConcept }, // R! Specifies the type of substitution allowed
"allowed" : <boolean> // R! Specifies if regulation allows for changes in the medication when dispensing
}],
"schedule" : [{ // Specifies the schedule of a medication in jurisdiction
"schedule" : { CodeableConcept } // R! Specifies the specific drug schedule
}],
"maxDispense" : { // The maximum number of units of the medication that can be dispensed in a period
"quantity" : { Quantity(SimpleQuantity) }, // R! The maximum number of units of the medication that can be dispensed
"period" : { Duration } // The period that applies to the maximum number of units
}
}],
"kinetics" : [{ // The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
"areaUnderCurve" : [{ Quantity(SimpleQuantity) }], // The drug concentration measured at certain discrete points in time
"lethalDose50" : [{ Quantity(SimpleQuantity) }], // The median lethal dose of a drug
"halfLifePeriod" : { Duration } // Time required for concentration in the body to decrease by half
}]
}
MedicationKnowledge Search Parameters
The following search parameters can be used to query MedicationKnowledge resources. Just submit them like so:
https://api.1up.health/fhir/r4/MedicationKnowledge?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
classification | text | medicineClassification.classification |
classification-type | text | medicineClassification.type |
code | text | code |
doseform | text | doseForm |
ingredient | reference | ingredient.item |
ingredient-code | text | ingredient.item |
manufacturer | reference | manufacturer |
monitoring-program-name | text | monitoringProgram.name |
monitoring-program-type | text | monitoringProgram.type |
monograph | reference | monograph.source |
monograph-type | text | monograph.type |
source-cost | text | cost.source |
status | text | status |
