--- type: "resource" title: "FormularyItem" resource: "FormularyItem" --- # FormularyItem ## Introduction ## Scope and Usage A FormularyItem is a product or service that is available through a program and includes the conditions and constraints of availability, e.g. amount limits, categorization, cost limits, and other requirements for use. This resource describes the program-specific information for a product or service. This information is specific to the inclusion of the item in the formulary and is not inherent to the item itself. ![](formularyitemscope.png) This diagram was created for the PDEX US Drug Formulary Implementation Guide but it shows where FormularyItem would fit in a drug context. If you abstract that to generic Insurance Plans to the left and to a set of resources that can be referenced to the right, that is the concept behind the FormularyItem resource. ## StructureDefinition ### Elements (Simplified) - **[FormularyItem](/formularyitem-definitions#FormularyItem)** [0..*]: - Definition of a FormularyItem - **[FormularyItem.identifier](/formularyitem-definitions#FormularyItem.identifier)** [0..*]: [Identifier](/Identifier) Business identifier for this formulary item - **[FormularyItem.status](/formularyitem-definitions#FormularyItem.status)** [1..1]: [code](/code) required:[formularyitem-status](/valueset-formularyitem-status) active | entered-in-error | inactive - **[FormularyItem.category](/formularyitem-definitions#FormularyItem.category)** [0..*]: [CodeableConcept](/CodeableConcept) Categorization of this formulary item - **[FormularyItem.context](/formularyitem-definitions#FormularyItem.context)** [0..1]: [CodeableReference](/CodeableReference) Owner of the formulary that this item was created for - **[FormularyItem.subject](/formularyitem-definitions#FormularyItem.subject)** [1..1]: [CodeableReference](/CodeableReference) Information that this item is about - **[FormularyItem.author](/formularyitem-definitions#FormularyItem.author)** [0..1]: [ContactDetail](/ContactDetail) Creator or owner of the information about the item - **[FormularyItem.cost](/formularyitem-definitions#FormularyItem.cost)** [0..*]: [BackboneElement](/BackboneElement) The pricing of the underlying item - **[FormularyItem.cost.effectiveDate](/formularyitem-definitions#FormularyItem.cost.effectiveDate)** [0..*]: [Period](/Period) The date range for which the cost is effective - **[FormularyItem.cost.type](/formularyitem-definitions#FormularyItem.cost.type)** [1..1]: [CodeableConcept](/CodeableConcept) The category of the cost information - **[FormularyItem.cost.source](/formularyitem-definitions#FormularyItem.cost.source)** [0..1]: [string](/string) The source or owner for the price information - **[FormularyItem.cost.cost[x]](/formularyitem-definitions#FormularyItem.cost.cost%5Bx%5D)** [1..1]: [Money](/Money), [CodeableConcept](/CodeableConcept) example:[medication-cost-category](/valueset-medication-cost-category) The price or category of the cost of the medication - **[FormularyItem.specialPrecaution](/formularyitem-definitions#FormularyItem.specialPrecaution)** [0..*]: [CodeableConcept](/CodeableConcept) Any precautions that affect the item - **[FormularyItem.monitoringProgram](/formularyitem-definitions#FormularyItem.monitoringProgram)** [0..*]: [BackboneElement](/BackboneElement) Program under which a item is reviewed - **[FormularyItem.monitoringProgram.type](/formularyitem-definitions#FormularyItem.monitoringProgram.type)** [0..1]: [CodeableConcept](/CodeableConcept) Type of program under which the item is monitored - **[FormularyItem.monitoringProgram.name](/formularyitem-definitions#FormularyItem.monitoringProgram.name)** [0..1]: [string](/string) Name of the reviewing program - **[FormularyItem.indicationGuideline](/formularyitem-definitions#FormularyItem.indicationGuideline)** [0..*]: [BackboneElement](/BackboneElement) Guidelines or protocols for administration of the medication for an indication - **[FormularyItem.indicationGuideline.indication](/formularyitem-definitions#FormularyItem.indicationGuideline.indication)** [0..*]: [CodeableReference](/CodeableReference) Indication for use that applies to the specific administration guideline - **[FormularyItem.indicationGuideline.dosingGuideline](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline)** [0..*]: [BackboneElement](/BackboneElement) Guidelines for dosage of the medication - **[FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent)** [0..1]: [CodeableConcept](/CodeableConcept) Intention of the treatment - **[FormularyItem.indicationGuideline.dosingGuideline.dosage](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.dosage)** [0..*]: [BackboneElement](/BackboneElement) Dosage for the medication for the specific guidelines - **[FormularyItem.indicationGuideline.dosingGuideline.dosage.type](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.dosage.type)** [1..1]: [CodeableConcept](/CodeableConcept) Category of dosage for a medication - **[FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage)** [1..*]: [Dosage](/Dosage) Dosage for the medication for the specific guidelines - **[FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment)** [0..1]: [CodeableConcept](/CodeableConcept) Type of treatment the guideline applies to - **[FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic)** [0..*]: [BackboneElement](/BackboneElement) Characteristics of the patient that are relevant to the administration guidelines - **[FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type)** [1..1]: [CodeableConcept](/CodeableConcept) Categorization of specific characteristic that is relevant to the administration guideline - **[FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]](/formularyitem-definitions#FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value%5Bx%5D)** [0..1]: [CodeableConcept](/CodeableConcept), [Quantity](/Quantity), [Range](/Range) The specific characteristic - **[FormularyItem.associatedDocuments](/formularyitem-definitions#FormularyItem.associatedDocuments)** [0..*]: Reference([DocumentReference](/DocumentReference)) Documents that provide more information about the item - **[FormularyItem.characteristic](/formularyitem-definitions#FormularyItem.characteristic)** [0..*]: [BackboneElement](/BackboneElement) Specifies descriptive properties of the item - **[FormularyItem.characteristic.type](/formularyitem-definitions#FormularyItem.characteristic.type)** [1..1]: [CodeableConcept](/CodeableConcept) Code specifying the type of characteristic of item - **[FormularyItem.characteristic.value[x]](/formularyitem-definitions#FormularyItem.characteristic.value%5Bx%5D)** [1..1]: [CodeableConcept](/CodeableConcept), [string](/string), [Quantity](/Quantity)([SimpleQuantity](/SimpleQuantity)), [base64Binary](/base64Binary), [Attachment](/Attachment) Description of the characteristic - **[FormularyItem.availabilityStatus](/formularyitem-definitions#FormularyItem.availabilityStatus)** [0..1]: [code](/code) required:[formularyitem-status](/valueset-formularyitem-status) active | entered-in-error | inactive - **[FormularyItem.availabilityPeriod](/formularyitem-definitions#FormularyItem.availabilityPeriod)** [0..1]: [Period](/Period) Time period of the availability of the item - **[FormularyItem.coverageInformation](/formularyitem-definitions#FormularyItem.coverageInformation)** [0..*]: [BackboneElement](/BackboneElement) Specific coverage information about the item - **[FormularyItem.coverageInformation.type](/formularyitem-definitions#FormularyItem.coverageInformation.type)** [1..1]: [CodeableConcept](/CodeableConcept) Code specifying the type of coverage information - **[FormularyItem.coverageInformation.coverage](/formularyitem-definitions#FormularyItem.coverageInformation.coverage)** [1..1]: Reference([Coverage](/Coverage)) Description of the coverage - **[FormularyItem.substitution](/formularyitem-definitions#FormularyItem.substitution)** [0..*]: [BackboneElement](/BackboneElement) Specifies if changes are allowed when dispensing a medication from a regulatory perspective - **[FormularyItem.substitution.type](/formularyitem-definitions#FormularyItem.substitution.type)** [1..1]: [CodeableConcept](/CodeableConcept) Specifies the type of substitution allowed - **[FormularyItem.substitution.allowed](/formularyitem-definitions#FormularyItem.substitution.allowed)** [1..1]: [boolean](/boolean) Specifies if regulation allows for changes in the medication when dispensing - **[FormularyItem.schedule](/formularyitem-definitions#FormularyItem.schedule)** [0..*]: [CodeableConcept](/CodeableConcept) Specifies the schedule of a medication in jurisdiction - **[FormularyItem.maxDispense](/formularyitem-definitions#FormularyItem.maxDispense)** [0..1]: [BackboneElement](/BackboneElement) The maximum number of units of the medication that can be dispensed in a period - **[FormularyItem.maxDispense.quantity](/formularyitem-definitions#FormularyItem.maxDispense.quantity)** [1..1]: [Quantity](/Quantity)([SimpleQuantity](/SimpleQuantity)) The maximum number of units of the medication that can be dispensed - **[FormularyItem.maxDispense.period](/formularyitem-definitions#FormularyItem.maxDispense.period)** [0..1]: [Duration](/Duration) The period that applies to the maximum number of units - **[FormularyItem.associatedItems](/formularyitem-definitions#FormularyItem.associatedItems)** [0..*]: [BackboneElement](/BackboneElement) Associated or related formulary items - **[FormularyItem.associatedItems.type](/formularyitem-definitions#FormularyItem.associatedItems.type)** [1..1]: [CodeableConcept](/CodeableConcept) Category of formulary item - **[FormularyItem.associatedItems.reference](/formularyitem-definitions#FormularyItem.associatedItems.reference)** [1..1]: Reference([FormularyItem](/FormularyItem)) Associated items about the formulary item ## Mappings - [FormularyItem Mappings](/formularyitem-mappings) — 6 mapping entries ## Implementation Guide ### implementationguide-FormularyItem-core.xml ```xml <status value="draft"/> <date value="2015-02-19T00:00:00.000"/> <publisher value="Health Level Seven, Inc. - FHIR WG"/> <description value="Defines common extensions used with or related to the FormularyItem resource"/> </ImplementationGuide> ``` ## Resource Packs ### list-FormularyItem-packs.xml ```xml <?xml version="1.0" encoding="UTF-8"?> <List xmlns="http://hl7.org/fhir" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://hl7.org/fhir ../../publish/List.xsd"> <id value="FormularyItem-packs"/> <status value="current"/> <mode value="working"/> <entry> <item> <reference value="ImplementationGuide/FormularyItem-core"/> </item> </entry> </List> ``` ## Search Parameters - [identifier](/formularyitem-search#identifier) — **token** — Returns formulary items with this external identifier — `FormularyItem.identifier` [Full Search Parameters](/formularyitem-search) ## Examples - [formularyitem-examples-header](/formularyitem-example-formularyitem-examples-header) — formularyitem-examples-header - [formularyitemexample01](/formularyitem-example-formularyitemexample01) — formularyitemexample01 — Penicillin V (as penicillin V potassium) 25 mg/mL oral solution [Full Examples](/formularyitem-examples) ## Mapping Exceptions ### formularyitem-fivews-mapping-exceptions.xml ### Unmapped Elements - **FiveWs.what** — Unknown - **FiveWs.recorded** — Unknown - **FiveWs.author** — Unknown - **FiveWs.cause** — Unknown - **FiveWs.version** — Unknown - **FiveWs.witness** — Unknown - **FiveWs.class** — Unknown - **FiveWs.where** — Unknown - **FiveWs.context** — Unknown - **FiveWs.init** — Unknown - **FiveWs.why** — Unknown - **FiveWs.source** — Unknown - **FiveWs.who** — Unknown - **FiveWs.grade** — Unknown - **FiveWs.status** — Unknown - **FiveWs.planned** — Unknown - **FiveWs.done** — Unknown - **FiveWs.subject** — Unknown