Medication - FHIR Resource (stu3)


This Medication Resource uses the FHIR API standard for access and structure.

Validate an Medication FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
codefalseCodeableConcept Codes that identify this medication
formfalseCodeableConcept powder | tablets | capsule +
imagetrueAttachment Picture of the medication
ingredienttrueData Type Active or inactive ingredient
isBrandfalseboolean True if a brand
isOverTheCounterfalseboolean True if medication does not require a prescription
manufacturerfalseReference Manufacturer of the item
packagefalseData Type Details about packaged medications
statusfalsecode active | inactive | entered-in-error

Medication Structure


  
{
  "resourceType" : "Medication",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "code" : { CodeableConcept }, // Codes that identify this medication
  "status" : "<code>", // active | inactive | entered-in-error
  "isBrand" : <boolean>, // True if a brand
  "isOverTheCounter" : <boolean>, // True if medication does not require a prescription
  "manufacturer" : { Reference(Organization) }, // Manufacturer of the item
  "form" : { CodeableConcept }, // powder | tablets | capsule +
  "ingredient" : [{ // Active or inactive ingredient
    // item[x]: The product contained. One of these 2:
    "itemCodeableConcept" : { CodeableConcept },
    "itemReference" : { Reference(Substance|Medication) },
    "isActive" : <boolean>, // Active ingredient indicator
    "amount" : { Ratio } // Quantity of ingredient present
  }],
  "package" : { // Details about packaged medications
    "container" : { CodeableConcept }, // E.g. box, vial, blister-pack
    "content" : [{ // What is  in the package
      // item[x]: The item in the package. One of these 2:
      "itemCodeableConcept" : { CodeableConcept },
      "itemReference" : { Reference(Medication) },
      "amount" : { Quantity(SimpleQuantity) } // Quantity present in the package
    }],
    "batch" : [{ // Identifies a single production run
      "lotNumber" : "<string>", // Identifier assigned to batch
      "expirationDate" : "<dateTime>" // When batch will expire
    }]
  },
  "image" : [{ Attachment }] // Picture of the medication
}


 

Medication Search Parameters

The following search parameters can be used to query Medication resources. Just submit the like so:

https://api.1up.health/fhir/stu3/Medication?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
codetextcode
containertextpackage.container
formtextform
ingredientreferenceingredient.item.as
ingredient-codetextingredient.item.as
manufacturerreferencemanufacturer
over-the-countertextisOverTheCounter
package-itemreferencepackage.content.item.as
package-item-codetextpackage.content.item.as
statustextstatus