type: resource-definitionsresource: FormularyItem

FormularyItem Definitions

FormularyItem

Definition of a 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.

Cardinality: 0..*

Mappings: w5=administrative.medication

FormularyItem.identifier

Business identifier for this formulary item

Definition: Business identifier for this formulary item.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; rim=.id

FormularyItem.status

active | entered-in-error | inactive

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

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.

Cardinality: 1..1

Type: code

Binding: required:formularyitem-status

Summary: true

Is Modifier: true (Reason: This element changes the interpretation of all descriptive attributes.)

Mappings: rim=.statusCode

FormularyItem.category

Categorization of this formulary item

Definition: Categorization for this formulary item.

Cardinality: 0..*

Type: CodeableConcept

FormularyItem.context

Owner of the formulary that this item was created for

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

Cardinality: 0..1

Type: CodeableReference

Summary: true

FormularyItem.subject

Information that this item is about

Definition: The information that this item is about.

Cardinality: 1..1

Type: CodeableReference

Summary: true

FormularyItem.author

Creator or owner of the information about the item

Definition: The creator or owner of the information about the item.

Cardinality: 0..1

Type: ContactDetail

Mappings: w5=FiveWs.actor; rim=ManufacturedProduct.subjectOf.DocumentEvent.author

FormularyItem.cost

The pricing of the underlying item

Definition: The price of the underlying item.

Cardinality: 0..*

Type: BackboneElement

FormularyItem.cost.effectiveDate

The date range for which the cost is effective

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

Cardinality: 0..*

Type: Period

FormularyItem.cost.type

The category of the cost information

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

Cardinality: 1..1

Type: CodeableConcept

FormularyItem.cost.source

The source or owner for the price information

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

Cardinality: 0..1

Type: string

FormularyItem.cost.cost[x]

The price or category of the cost of the medication

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

Cardinality: 1..1

Type: Money, CodeableConcept

Binding: example:medication-cost-category

FormularyItem.specialPrecaution

Any precautions that affect the item

Definition: Any precautions that affect the item.

Cardinality: 0..*

Type: CodeableConcept

FormularyItem.monitoringProgram

Program under which a item is reviewed

Definition: The program under which the item is reviewed.

Cardinality: 0..*

Type: BackboneElement

Summary: true

FormularyItem.monitoringProgram.type

Type of program under which the item is monitored

Definition: Type of program under which the item is monitored.

Cardinality: 0..1

Type: CodeableConcept

FormularyItem.monitoringProgram.name

Name of the reviewing program

Definition: Name of the reviewing program.

Cardinality: 0..1

Type: string

FormularyItem.indicationGuideline

Guidelines or protocols for administration of the medication for an indication

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

Cardinality: 0..*

Type: BackboneElement

FormularyItem.indicationGuideline.indication

Indication for use that applies to the specific administration guideline

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

Cardinality: 0..*

Type: CodeableReference

FormularyItem.indicationGuideline.dosingGuideline

Guidelines for dosage of the medication

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

Cardinality: 0..*

Type: BackboneElement

FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent

Intention of the treatment

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

Cardinality: 0..1

Type: CodeableConcept

FormularyItem.indicationGuideline.dosingGuideline.dosage

Dosage for the medication for the specific guidelines

Definition: Dosage for the medication for the specific guidelines.

Cardinality: 0..*

Type: BackboneElement

FormularyItem.indicationGuideline.dosingGuideline.dosage.type

Category of dosage for a medication

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

Cardinality: 1..1

Type: CodeableConcept

FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage

Dosage for the medication for the specific guidelines

Definition: Dosage for the medication for the specific guidelines.

Cardinality: 1..*

Type: Dosage

FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment

Type of treatment the guideline applies to

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

Cardinality: 0..1

Type: CodeableConcept

FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic

Characteristics of the patient that are relevant to the administration guidelines

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

Cardinality: 0..*

Type: BackboneElement

FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type

Categorization of specific characteristic that is relevant to the administration guideline

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

Cardinality: 1..1

Type: CodeableConcept

FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]

The specific characteristic

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

Cardinality: 0..1

Type: CodeableConcept, Quantity, Range

FormularyItem.associatedDocuments

Documents that provide more information about the item

Definition: Documents that provide more information about the item.

Cardinality: 0..*

Type: Reference(DocumentReference)

FormularyItem.characteristic

Specifies descriptive properties of the item

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

Cardinality: 0..*

Type: BackboneElement

FormularyItem.characteristic.type

Code specifying the type of characteristic of item

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

Cardinality: 1..1

Type: CodeableConcept

FormularyItem.characteristic.value[x]

Description of the characteristic

Definition: Description of the characteristic.

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.

Cardinality: 1..1

Type: CodeableConcept, string, Quantity(SimpleQuantity), base64Binary, Attachment

FormularyItem.availabilityStatus

active | entered-in-error | inactive

Definition: Status of the availability of the item.

Cardinality: 0..1

Type: code

Binding: required:formularyitem-status

FormularyItem.availabilityPeriod

Time period of the availability of the item

Definition: Time period of the availability of the item.

Cardinality: 0..1

Type: Period

FormularyItem.coverageInformation

Specific coverage information about the item

Definition: Specific coverage information about the item.

Cardinality: 0..*

Type: BackboneElement

FormularyItem.coverageInformation.type

Code specifying the type of coverage information

Definition: A code specifying the type of coverage information.

Cardinality: 1..1

Type: CodeableConcept

FormularyItem.coverageInformation.coverage

Description of the coverage

Definition: Description of the coverage.

Cardinality: 1..1

Type: Reference(Coverage)

FormularyItem.substitution

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

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

Cardinality: 0..*

Type: BackboneElement

FormularyItem.substitution.type

Specifies the type of substitution allowed

Definition: Specifies the type of substitution allowed.

Cardinality: 1..1

Type: CodeableConcept

FormularyItem.substitution.allowed

Specifies if regulation allows for changes in the medication when dispensing

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

Cardinality: 1..1

Type: boolean

FormularyItem.schedule

Specifies the schedule of a medication in jurisdiction

Definition: Specifies the schedule of a medication in jurisdiction.

Cardinality: 0..*

Type: CodeableConcept

FormularyItem.maxDispense

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

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

Cardinality: 0..1

Type: BackboneElement

FormularyItem.maxDispense.quantity

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

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

Cardinality: 1..1

Type: Quantity(SimpleQuantity)

FormularyItem.maxDispense.period

The period that applies to the maximum number of units

Definition: The period that applies to the maximum number of units.

Cardinality: 0..1

Type: Duration

FormularyItem.associatedItems

Associated or related formulary items

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).

Cardinality: 0..*

Type: BackboneElement

FormularyItem.associatedItems.type

Category of formulary item

Definition: The category of the associated formulary item reference.

Cardinality: 1..1

Type: CodeableConcept

FormularyItem.associatedItems.reference

Associated items about the formulary item

Definition: Associated items about the formulary item.

Cardinality: 1..1

Type: Reference(FormularyItem)