MedicationKnowledge

ResourceClinical · MedicationsTrial useMaturity 0

Information about a medication that is used to support knowledge.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

13 of 13 parameters tested

Structure

Show inherited elements (56)

Element	Card.	Type	Description
codeΣ	0..1	CodeableConcept	Code that identifies this medicationBinding (example): medication-codes
status?!Σ	0..1	code	active | inactive | entered-in-errorBinding (required): medicationknowledge-status
manufacturerΣ	0..1	Reference(Organization)	Manufacturer of the item
doseForm	0..1	CodeableConcept	powder | tablets | capsule +Binding (example): medication-form-codes
amountΣ	0..1	Quantity	Amount of drug in package
synonymΣ	0..*	string	Additional names for a medication
relatedMedicationKnowledge	0..*	BackboneElement	Associated or related medication information
typeRequired	1..1	CodeableConcept	Category of medicationKnowledge
referenceRequired	1..*	Reference(MedicationKnowledge)	Associated documentation about the associated medication knowledge
associatedMedication	0..*	Reference(Medication)	A medication resource that is associated with this medication
productType	0..*	CodeableConcept	Category of the medication or product
monograph	0..*	BackboneElement	Associated documentation about the medication
type	0..1	CodeableConcept	The category of medication document
source	0..1	Reference(DocumentReference | Media)	Associated documentation about the medication
ingredient	0..*	BackboneElement	Active or inactive ingredient
item[x]Required	1..1	CodeableConcept | Reference(Substance)	Medication(s) or substance(s) contained in the medication
isActive	0..1	boolean	Active ingredient indicator
strength	0..1	Ratio	Quantity of ingredient present
preparationInstruction	0..1	markdown	The instructions for preparing the medication
intendedRoute	0..*	CodeableConcept	The intended or approved route of administrationBinding (example): route-codes
cost	0..*	BackboneElement	The pricing of the medication
typeRequired	1..1	CodeableConcept	The category of the cost information
source	0..1	string	The source or owner for the price information
costRequired	1..1	Money	The price of the medication
monitoringProgram	0..*	BackboneElement	Program under which a medication is reviewed
type	0..1	CodeableConcept	Type of program under which the medication is monitored
name	0..1	string	Name of the reviewing program
administrationGuidelines	0..*	BackboneElement	Guidelines for administration of the medication
dosage	0..*	BackboneElement	Dosage for the medication for the specific guidelines
typeRequired	1..1	CodeableConcept	Type of dosage
dosageRequired	1..*	Dosage	Dosage for the medication for the specific guidelines
indication[x]	0..1	CodeableConcept | Reference(ObservationDefinition)	Indication for use that apply to the specific administration guidelines
patientCharacteristics	0..*	BackboneElement	Characteristics of the patient that are relevant to the administration guidelines
characteristic[x]Required	1..1	CodeableConcept | Quantity	Specific characteristic that is relevant to the administration guideline
value	0..*	string	The specific characteristic
medicineClassification	0..*	BackboneElement	Categorization of the medication within a formulary or classification system
typeRequired	1..1	CodeableConcept	The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
classification	0..*	CodeableConcept	Specific category assigned to the medication
packaging	0..1	BackboneElement	Details about packaged medications
type	0..1	CodeableConcept	A code that defines the specific type of packaging that the medication can be found inBinding (example): medicationknowledge-package-type
quantity	0..1	Quantity	The number of product units the package would contain if fully loaded
drugCharacteristic	0..*	BackboneElement	Specifies descriptive properties of the medicine
type	0..1	CodeableConcept	Code specifying the type of characteristic of medicationBinding (example): medicationknowledge-characteristic
value[x]	0..1	CodeableConcept | string | Quantity | base64Binary	Description of the characteristic
contraindication	0..*	Reference(DetectedIssue)	Potential clinical issue with or between medication(s)
regulatory	0..*	BackboneElement	Regulatory information about a medication
regulatoryAuthorityRequired	1..1	Reference(Organization)	Specifies the authority of the regulation
substitution	0..*	BackboneElement	Specifies if changes are allowed when dispensing a medication from a regulatory perspective
typeRequired	1..1	CodeableConcept	Specifies the type of substitution allowed
allowedRequired	1..1	boolean	Specifies if regulation allows for changes in the medication when dispensing
schedule	0..*	BackboneElement	Specifies the schedule of a medication in jurisdiction
scheduleRequired	1..1	CodeableConcept	Specifies the specific drug schedule
maxDispense	0..1	BackboneElement	The maximum number of units of the medication that can be dispensed in a period
quantityRequired	1..1	Quantity	The maximum number of units of the medication that can be dispensed
period	0..1	Duration	The period that applies to the maximum number of units
kinetics	0..*	BackboneElement	The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
areaUnderCurve	0..*	Quantity	The drug concentration measured at certain discrete points in time
lethalDose50	0..*	Quantity	The median lethal dose of a drug
halfLifePeriod	0..1	Duration	Time required for concentration in the body to decrease by half

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/MedicationKnowledge?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
classification	token	Specific category assigned to the medication MedicationKnowledge.medicineClassification.classification
classification-type	token	The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) MedicationKnowledge.medicineClassification.type
code	token	Code that identifies this medication MedicationKnowledge.code
doseform	token	powder | tablets | capsule + MedicationKnowledge.doseForm
ingredient	reference	Medication(s) or substance(s) contained in the medication (MedicationKnowledge.ingredient.item.ofType(Reference))
ingredient-code	token	Medication(s) or substance(s) contained in the medication (MedicationKnowledge.ingredient.item.ofType(CodeableConcept))
manufacturer	reference	Manufacturer of the item MedicationKnowledge.manufacturer
monitoring-program-name	token	Name of the reviewing program MedicationKnowledge.monitoringProgram.name
monitoring-program-type	token	Type of program under which the medication is monitored MedicationKnowledge.monitoringProgram.type
monograph	reference	Associated documentation about the medication MedicationKnowledge.monograph.source
monograph-type	token	The category of medication document MedicationKnowledge.monograph.type
source-cost	token	The source or owner for the price information MedicationKnowledge.cost.source
status	token	active | inactive | entered-in-error MedicationKnowledge.status

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition