FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Pharmacy icon Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the FormularyItem resource.

Element Id FormularyItem
Definition

This resource describes a product or service that is available through a program and includes the conditions and constraints of availability. All of the information in this resource is specific to the inclusion of the item in the formulary and is not inherent to the item itself.

Short Display Definition of a FormularyItem
Cardinality 0..*
Type DomainResource
Summary false
Element Id FormularyItem.identifier
Definition

Business identifier for this formulary item.

Short Display Business identifier for this formulary item
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Summary true
Element Id FormularyItem.status
Definition

The validity about the information of the formulary item and not of the underlying product or service itself.

Short Display active | entered-in-error | inactive
Cardinality 1..1
Terminology Binding FormularyItem Status Codes (Required)
Type code
Is Modifier true (Reason: This element changes the interpretation of all descriptive attributes.)
Summary true
Comments

This status is intended to identify if the formulary item in a local system is in active use within the formulary. For example, a formulary might include a medicinal product and the status relates to its inclusion. At some point in the future, if the status of the formulary item is changed to "inactive" that means that it is no longer valid in the formulary. But the product itself might still be in active use and might be included in other formularies.

Element Id FormularyItem.category
Definition

Categorization for this formulary item.

Short Display Categorization of this formulary item
Cardinality 0..*
Type CodeableConcept
Summary false
Element Id FormularyItem.context
Definition

The owner of the formulary that this item was created for.

Short Display Owner of the formulary that this item was created for
Cardinality 0..1
Type CodeableReference(Organization | InsurancePlan)
Summary true
Element Id FormularyItem.subject
Definition

The information that this item is about.

Short Display Information that this item is about
Cardinality 1..1
Type CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | MedicinalProductDefinition | DeviceDefinition | ObservationDefinition | ActivityDefinition)
Summary true
Element Id FormularyItem.author
Definition

The creator or owner of the information about the item.

Short Display Creator or owner of the information about the item
Cardinality 0..1
Type ContactDetail
Summary false
Element Id FormularyItem.cost
Definition

The price of the underlying item.

Short Display The pricing of the underlying item
Cardinality 0..*
Summary false
Element Id FormularyItem.cost.effectiveDate
Definition

The date range for which the cost information of the medication is effective.

Short Display The date range for which the cost is effective
Cardinality 0..*
Type Period
Summary false
Element Id FormularyItem.cost.type
Definition

The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.

Short Display The category of the cost information
Cardinality 1..1
Type CodeableConcept
Summary false
Element Id FormularyItem.cost.source
Definition

The source or owner that assigns the price to the medication.

Short Display The source or owner for the price information
Cardinality 0..1
Type string
Summary false
Element Id FormularyItem.cost.cost[x]
Definition

The price or representation of the cost (for example, Band A, Band B or $, $$) of the item.

Short Display The price or category of the cost of the medication
Cardinality 1..1
Terminology Binding Medication Cost Category Codes (Example)
Type Money|CodeableConcept
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Element Id FormularyItem.specialPrecaution
Definition

Any precautions that affect the item.

Short Display Any precautions that affect the item
Cardinality 0..*
Type CodeableConcept
Summary false
Element Id FormularyItem.monitoringProgram
Definition

The program under which the item is reviewed.

Short Display Program under which a item is reviewed
Cardinality 0..*
Summary true
Element Id FormularyItem.monitoringProgram.type
Definition

Type of program under which the item is monitored.

Short Display Type of program under which the item is monitored
Cardinality 0..1
Type CodeableConcept
Summary false
Element Id FormularyItem.monitoringProgram.name
Definition

Name of the reviewing program.

Short Display Name of the reviewing program
Cardinality 0..1
Type string
Summary false
Element Id FormularyItem.indicationGuideline
Definition

Guidelines or protocols that are applicable for the administration of the medication based on indication.

Short Display Guidelines or protocols for administration of the medication for an indication
Cardinality 0..*
Summary false
Element Id FormularyItem.indicationGuideline.indication
Definition

Indication or reason for use of the medication that applies to the specific administration guideline.

Short Display Indication for use that applies to the specific administration guideline
Cardinality 0..*
Type CodeableReference(ClinicalUseDefinition)
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline
Definition

The guidelines for the dosage of the medication for the indication.

Short Display Guidelines for dosage of the medication
Cardinality 0..*
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent
Definition

The overall intention of the treatment, for example, prophylactic, supporative, curative, etc.

Short Display Intention of the treatment
Cardinality 0..1
Type CodeableConcept
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.dosage
Definition

Dosage for the medication for the specific guidelines.

Short Display Dosage for the medication for the specific guidelines
Cardinality 0..*
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.dosage.type
Definition

The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).

Short Display Category of dosage for a medication
Cardinality 1..1
Type CodeableConcept
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage
Definition

Dosage for the medication for the specific guidelines.

Short Display Dosage for the medication for the specific guidelines
Cardinality 1..*
Type Dosage
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment
Definition

The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.

Short Display Type of treatment the guideline applies to
Cardinality 0..1
Type CodeableConcept
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic
Definition

Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).

Short Display Characteristics of the patient that are relevant to the administration guidelines
Cardinality 0..*
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type
Definition

The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).

Short Display Categorization of specific characteristic that is relevant to the administration guideline
Cardinality 1..1
Type CodeableConcept
Summary false
Element Id FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]
Definition

The specific characteristic (e.g. height, weight, gender, etc.).

Short Display The specific characteristic
Cardinality 0..1
Type CodeableConcept|Quantity|Range
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Element Id FormularyItem.associatedDocuments
Definition

Documents that provide more information about the item.

Short Display Documents that provide more information about the item
Cardinality 0..*
Type Reference
Summary false
Element Id FormularyItem.characteristic
Definition

Specifies descriptive properties of the item, such as color, shape, imprints, etc.

Short Display Specifies descriptive properties of the item
Cardinality 0..*
Summary false
Element Id FormularyItem.characteristic.type
Definition

A code specifying which characteristic of the item is being described (for example, colour, shape, imprint).

Short Display Code specifying the type of characteristic of item
Cardinality 1..1
Type CodeableConcept
Summary false
Element Id FormularyItem.characteristic.value[x]
Definition

Description of the characteristic.

Short Display Description of the characteristic
Cardinality 1..1
Type CodeableConcept|string|SimpleQuantity|base64Binary|Attachment
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary false
Comments

The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.

Element Id FormularyItem.availabilityStatus
Definition

Status of the availability of the item.

Short Display active | entered-in-error | inactive
Cardinality 0..1
Terminology Binding FormularyItem Status Codes (Required)
Type code
Summary false
Element Id FormularyItem.availabilityPeriod
Definition

Time period of the availability of the item.

Short Display Time period of the availability of the item
Cardinality 0..1
Type Period
Summary false
Element Id FormularyItem.coverageInformation
Definition

Specific coverage information about the item.

Short Display Specific coverage information about the item
Cardinality 0..*
Summary false
Element Id FormularyItem.coverageInformation.type
Definition

A code specifying the type of coverage information.

Short Display Code specifying the type of coverage information
Cardinality 1..1
Type CodeableConcept
Summary false
Element Id FormularyItem.coverageInformation.coverage
Definition

Description of the coverage.

Short Display Description of the coverage
Cardinality 1..1
Type Reference
Summary false
Element Id FormularyItem.substitution
Definition

Specifies if changes are allowed when dispensing a medication from a regulatory perspective.

Short Display Specifies if changes are allowed when dispensing a medication from a regulatory perspective
Cardinality 0..*
Summary false
Element Id FormularyItem.substitution.type
Definition

Specifies the type of substitution allowed.

Short Display Specifies the type of substitution allowed
Cardinality 1..1
Type CodeableConcept
Summary false
Element Id FormularyItem.substitution.allowed
Definition

Specifies if regulation allows for changes in the medication when dispensing.

Short Display Specifies if regulation allows for changes in the medication when dispensing
Cardinality 1..1
Type boolean
Summary false
Element Id FormularyItem.schedule
Definition

Specifies the schedule of a medication in jurisdiction.

Short Display Specifies the schedule of a medication in jurisdiction
Cardinality 0..*
Type CodeableConcept
Summary false
Element Id FormularyItem.maxDispense
Definition

The maximum number of units of the medication that can be dispensed in a period.

Short Display The maximum number of units of the medication that can be dispensed in a period
Cardinality 0..1
Summary false
Element Id FormularyItem.maxDispense.quantity
Definition

The maximum number of units of the medication that can be dispensed.

Short Display The maximum number of units of the medication that can be dispensed
Cardinality 1..1
Type SimpleQuantity
Summary false
Element Id FormularyItem.maxDispense.period
Definition

The period that applies to the maximum number of units.

Short Display The period that applies to the maximum number of units
Cardinality 0..1
Type Duration
Summary false
Element Id FormularyItem.associatedItems
Definition

Associated or related items. For example, if the item is about a branded product (e.g. Crestor), this could link to the generic medication (e.g. Rosuvastatin).

Short Display Associated or related formulary items
Cardinality 0..*
Summary false
Element Id FormularyItem.associatedItems.type
Definition

The category of the associated formulary item reference.

Short Display Category of formulary item
Cardinality 1..1
Type CodeableConcept
Summary false
Element Id FormularyItem.associatedItems.reference
Definition

Associated items about the formulary item.

Short Display Associated items about the formulary item
Cardinality 1..1
Type Reference(FormularyItem)
Summary false