medication knowledges

Create Medication Knowledge

post
/organizations/{organizationId}/fhir/4/MedicationKnowledge

Information about a medication that is used to support knowledge.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a MedicationKnowledge 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
codeCodeableConceptA code that specifies 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. The status refers to the validity about the information of the medication and not to its medicinal properties.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
doseFormCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
amountQuantitySpecific 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.).
synonymarray(string)Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
relatedMedicationKnowledgearray(MedicationKnowledge_RelatedMedicationKnowledge)Associated or related knowledge about a medication.
associatedMedicationarray(Reference)Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
productTypearray(CodeableConcept)Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
monographarray(MedicationKnowledge_Monograph)Associated documentation about the medication.
ingredientarray(MedicationKnowledge_Ingredient)Identifies a particular constituent of interest in the product.
preparationInstructionmarkdownThe instructions for preparing the medication.
intendedRoutearray(CodeableConcept)The intended or approved route of administration.
costarray(MedicationKnowledge_Cost)The price of the medication.
monitoringProgramarray(MedicationKnowledge_MonitoringProgram)The program under which the medication is reviewed.
administrationGuidelinesarray(MedicationKnowledge_AdministrationGuidelines)Guidelines for the administration of the medication.
medicineClassificationarray(MedicationKnowledge_MedicineClassification)Categorization of the medication within a formulary or classification system.
packagingMedicationKnowledge_PackagingInformation that only applies to packages (not products).
drugCharacteristicarray(MedicationKnowledge_DrugCharacteristic)Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
contraindicationarray(Reference)Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
regulatoryarray(MedicationKnowledge_Regulatory)Regulatory information about a medication.
kineticsarray(MedicationKnowledge_Kinetics)The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

Response

Patch Medication Knowledge

patch
/organizations/{organizationId}/fhir/4/MedicationKnowledge/{resourceId}

Information about a medication that is used to support knowledge.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a MedicationKnowledge 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
codeCodeableConceptA code that specifies 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. The status refers to the validity about the information of the medication and not to its medicinal properties.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
doseFormCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
amountQuantitySpecific 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.).
synonymarray(string)Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
relatedMedicationKnowledgearray(MedicationKnowledge_RelatedMedicationKnowledge)Associated or related knowledge about a medication.
associatedMedicationarray(Reference)Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
productTypearray(CodeableConcept)Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
monographarray(MedicationKnowledge_Monograph)Associated documentation about the medication.
ingredientarray(MedicationKnowledge_Ingredient)Identifies a particular constituent of interest in the product.
preparationInstructionmarkdownThe instructions for preparing the medication.
intendedRoutearray(CodeableConcept)The intended or approved route of administration.
costarray(MedicationKnowledge_Cost)The price of the medication.
monitoringProgramarray(MedicationKnowledge_MonitoringProgram)The program under which the medication is reviewed.
administrationGuidelinesarray(MedicationKnowledge_AdministrationGuidelines)Guidelines for the administration of the medication.
medicineClassificationarray(MedicationKnowledge_MedicineClassification)Categorization of the medication within a formulary or classification system.
packagingMedicationKnowledge_PackagingInformation that only applies to packages (not products).
drugCharacteristicarray(MedicationKnowledge_DrugCharacteristic)Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
contraindicationarray(Reference)Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
regulatoryarray(MedicationKnowledge_Regulatory)Regulatory information about a medication.
kineticsarray(MedicationKnowledge_Kinetics)The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

Response

Read Medication Knowledge

get
/organizations/{organizationId}/fhir/4/MedicationKnowledge/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Medication Knowledge

get
/organizations/{organizationId}/fhir/4/MedicationKnowledge/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Medication Knowledge

get
/organizations/{organizationId}/fhir/4/MedicationKnowledge/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Medication Knowledge

delete
/organizations/{organizationId}/fhir/4/MedicationKnowledge/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Medication Knowledge

get
/organizations/{organizationId}/fhir/4/MedicationKnowledge

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
classificationstring
classification-typestring
codestring
doseformstring
ingredientstring
ingredient-codestring
manufacturerstring
monitoring-program-namestring
monitoring-program-typestring
monographstring
monograph-typestring
source-coststring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Medication Knowledge

get
/organizations/{organizationId}/fhir/4/MedicationKnowledge/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Medication Knowledge

post
/organizations/{organizationId}/fhir/4/MedicationKnowledge/_search

Information about a medication that is used to support knowledge.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
classificationstring
classification-typestring
codestring
doseformstring
ingredientstring
ingredient-codestring
manufacturerstring
monitoring-program-namestring
monitoring-program-typestring
monographstring
monograph-typestring
source-coststring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a MedicationKnowledge 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
codeCodeableConceptA code that specifies 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. The status refers to the validity about the information of the medication and not to its medicinal properties.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
doseFormCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
amountQuantitySpecific 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.).
synonymarray(string)Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
relatedMedicationKnowledgearray(MedicationKnowledge_RelatedMedicationKnowledge)Associated or related knowledge about a medication.
associatedMedicationarray(Reference)Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
productTypearray(CodeableConcept)Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
monographarray(MedicationKnowledge_Monograph)Associated documentation about the medication.
ingredientarray(MedicationKnowledge_Ingredient)Identifies a particular constituent of interest in the product.
preparationInstructionmarkdownThe instructions for preparing the medication.
intendedRoutearray(CodeableConcept)The intended or approved route of administration.
costarray(MedicationKnowledge_Cost)The price of the medication.
monitoringProgramarray(MedicationKnowledge_MonitoringProgram)The program under which the medication is reviewed.
administrationGuidelinesarray(MedicationKnowledge_AdministrationGuidelines)Guidelines for the administration of the medication.
medicineClassificationarray(MedicationKnowledge_MedicineClassification)Categorization of the medication within a formulary or classification system.
packagingMedicationKnowledge_PackagingInformation that only applies to packages (not products).
drugCharacteristicarray(MedicationKnowledge_DrugCharacteristic)Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
contraindicationarray(Reference)Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
regulatoryarray(MedicationKnowledge_Regulatory)Regulatory information about a medication.
kineticsarray(MedicationKnowledge_Kinetics)The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

Response

Update Medication Knowledge

put
/organizations/{organizationId}/fhir/4/MedicationKnowledge/{resourceId}

Information about a medication that is used to support knowledge.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a MedicationKnowledge 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.
containedarray(ResourceList)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.
extensionarray(Extension)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.
modifierExtensionarray(Extension)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).
codeCodeableConceptA code that specifies 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. The status refers to the validity about the information of the medication and not to its medicinal properties.
manufacturerReferenceDescribes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.
doseFormCodeableConceptDescribes the form of the item. Powder; tablets; capsule.
amountQuantitySpecific 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.).
synonymarray(string)Additional names for a medication, for example, the name(s) given to a medication in different countries. For example, acetaminophen and paracetamol or salbutamol and albuterol.
relatedMedicationKnowledgearray(MedicationKnowledge_RelatedMedicationKnowledge)Associated or related knowledge about a medication.
associatedMedicationarray(Reference)Associated or related medications. For example, if the medication is a branded product (e.g. Crestor), this is the Therapeutic Moeity (e.g. Rosuvastatin) or if this is a generic medication (e.g. Rosuvastatin), this would link to a branded product (e.g. Crestor).
productTypearray(CodeableConcept)Category of the medication or product (e.g. branded product, therapeutic moeity, generic product, innovator product, etc.).
monographarray(MedicationKnowledge_Monograph)Associated documentation about the medication.
ingredientarray(MedicationKnowledge_Ingredient)Identifies a particular constituent of interest in the product.
preparationInstructionmarkdownThe instructions for preparing the medication.
intendedRoutearray(CodeableConcept)The intended or approved route of administration.
costarray(MedicationKnowledge_Cost)The price of the medication.
monitoringProgramarray(MedicationKnowledge_MonitoringProgram)The program under which the medication is reviewed.
administrationGuidelinesarray(MedicationKnowledge_AdministrationGuidelines)Guidelines for the administration of the medication.
medicineClassificationarray(MedicationKnowledge_MedicineClassification)Categorization of the medication within a formulary or classification system.
packagingMedicationKnowledge_PackagingInformation that only applies to packages (not products).
drugCharacteristicarray(MedicationKnowledge_DrugCharacteristic)Specifies descriptive properties of the medicine, such as color, shape, imprints, etc.
contraindicationarray(Reference)Potential clinical issue with or between medication(s) (for example, drug-drug interaction, drug-disease contraindication, drug-allergy interaction, etc.).
regulatoryarray(MedicationKnowledge_Regulatory)Regulatory information about a medication.
kineticsarray(MedicationKnowledge_Kinetics)The time course of drug absorption, distribution, metabolism and excretion of a medication from the body.

Response