FHIR R6 Pharmacy Incubator
0.1.0 - ci-build International flag

FHIR R6 Pharmacy Incubator, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/phx-incubator/ and changes regularly. See the Directory of published versions

Resource Profile: Formulary Item

Official URL: http://hl7.org/fhir/StructureDefinition/FormularyItem Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: FormularyItem
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1118

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.

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.

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FormularyItem 0..* DomainResource Definition of a FormularyItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for this formulary item
... status ?!Σ 1..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... category 0..* CodeableConcept Categorization of this formulary item
... context Σ 0..1 CodeableReference(Organization | InsurancePlan) Owner of the formulary that this item was created for
... subject Σ 1..1 CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) Information that this item is about
... author 0..1 ContactDetail Creator or owner of the information about the item
... cost 0..* BackboneElement The pricing of the underlying item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... specialPrecaution 0..* CodeableConcept Any precautions that affect the item
... monitoringProgram Σ 0..* BackboneElement Program under which a item is reviewed
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the item is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline
.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines
..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... associatedDocuments 0..* Reference(DocumentReference) Documents that provide more information about the item
... characteristic 0..* BackboneElement Specifies descriptive properties of the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of characteristic of item
.... value[x] 1..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
... availabilityStatus 0..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... availabilityPeriod 0..1 Period Time period of the availability of the item
... coverageInformation 0..* BackboneElement Specific coverage information about the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of coverage information
.... coverage 1..1 Reference(Coverage) Description of the coverage
... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Specifies the type of substitution allowed
.... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
.... period 0..1 Duration The period that applies to the maximum number of units
... associatedItems 0..* BackboneElement Associated or related formulary items
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of formulary item
.... reference 1..1 Reference(Formulary Item) Associated items about the formulary item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FormularyItem.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
FormularyItem.status Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.cost.cost[x] Base example Medication Cost Category Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.availabilityStatus Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error FormularyItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FormularyItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FormularyItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FormularyItem 0..* DomainResource Definition of a FormularyItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier for this formulary item
... status ?!Σ 1..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... category 0..* CodeableConcept Categorization of this formulary item
... subject Σ 1..1 CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) Information that this item is about
... author 0..1 ContactDetail Creator or owner of the information about the item
... cost 0..* BackboneElement The pricing of the underlying item
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... specialPrecaution 0..* CodeableConcept Any precautions that affect the item
... monitoringProgram Σ 0..* BackboneElement Program under which a item is reviewed
.... type 0..1 CodeableConcept Type of program under which the item is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication
.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline
.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines
..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... associatedDocuments 0..* Reference(DocumentReference) Documents that provide more information about the item
... characteristic 0..* BackboneElement Specifies descriptive properties of the item
.... type 1..1 CodeableConcept Code specifying the type of characteristic of item
.... value[x] 1..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
... availabilityStatus 0..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... availabilityPeriod 0..1 Period Time period of the availability of the item
... coverageInformation 0..* BackboneElement Specific coverage information about the item
.... type 1..1 CodeableConcept Code specifying the type of coverage information
.... coverage 1..1 Reference(Coverage) Description of the coverage
... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
.... type 1..1 CodeableConcept Specifies the type of substitution allowed
.... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
.... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
.... period 0..1 Duration The period that applies to the maximum number of units
... associatedItems 0..* BackboneElement Associated or related formulary items
.... type 1..1 CodeableConcept Category of formulary item
.... reference 1..1 Reference(Formulary Item) Associated items about the formulary item

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
FormularyItem.status Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.cost.cost[x] Base example Medication Cost Category Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.availabilityStatus Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FormularyItem 0..* DomainResource Definition of a FormularyItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for this formulary item
... status ?!Σ 1..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... category 0..* CodeableConcept Categorization of this formulary item
... context Σ 0..1 CodeableReference(Organization | InsurancePlan) Owner of the formulary that this item was created for
... subject Σ 1..1 CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) Information that this item is about
... author 0..1 ContactDetail Creator or owner of the information about the item
... cost 0..* BackboneElement The pricing of the underlying item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... specialPrecaution 0..* CodeableConcept Any precautions that affect the item
... monitoringProgram Σ 0..* BackboneElement Program under which a item is reviewed
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the item is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline
.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines
..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... associatedDocuments 0..* Reference(DocumentReference) Documents that provide more information about the item
... characteristic 0..* BackboneElement Specifies descriptive properties of the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of characteristic of item
.... value[x] 1..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
... availabilityStatus 0..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... availabilityPeriod 0..1 Period Time period of the availability of the item
... coverageInformation 0..* BackboneElement Specific coverage information about the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of coverage information
.... coverage 1..1 Reference(Coverage) Description of the coverage
... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Specifies the type of substitution allowed
.... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
.... period 0..1 Duration The period that applies to the maximum number of units
... associatedItems 0..* BackboneElement Associated or related formulary items
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of formulary item
.... reference 1..1 Reference(Formulary Item) Associated items about the formulary item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FormularyItem.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
FormularyItem.status Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.cost.cost[x] Base example Medication Cost Category Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.availabilityStatus Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error FormularyItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FormularyItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FormularyItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from DomainResource

Summary

Mandatory: 0 element(16 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FormularyItem 0..* DomainResource Definition of a FormularyItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for this formulary item
... status ?!Σ 1..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... category 0..* CodeableConcept Categorization of this formulary item
... context Σ 0..1 CodeableReference(Organization | InsurancePlan) Owner of the formulary that this item was created for
... subject Σ 1..1 CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) Information that this item is about
... author 0..1 ContactDetail Creator or owner of the information about the item
... cost 0..* BackboneElement The pricing of the underlying item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... specialPrecaution 0..* CodeableConcept Any precautions that affect the item
... monitoringProgram Σ 0..* BackboneElement Program under which a item is reviewed
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the item is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline
.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines
..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... associatedDocuments 0..* Reference(DocumentReference) Documents that provide more information about the item
... characteristic 0..* BackboneElement Specifies descriptive properties of the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of characteristic of item
.... value[x] 1..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
... availabilityStatus 0..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... availabilityPeriod 0..1 Period Time period of the availability of the item
... coverageInformation 0..* BackboneElement Specific coverage information about the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of coverage information
.... coverage 1..1 Reference(Coverage) Description of the coverage
... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Specifies the type of substitution allowed
.... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
.... period 0..1 Duration The period that applies to the maximum number of units
... associatedItems 0..* BackboneElement Associated or related formulary items
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of formulary item
.... reference 1..1 Reference(Formulary Item) Associated items about the formulary item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FormularyItem.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
FormularyItem.status Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.cost.cost[x] Base example Medication Cost Category Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.availabilityStatus Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error FormularyItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FormularyItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FormularyItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FormularyItem 0..* DomainResource Definition of a FormularyItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ 0..* Identifier Business identifier for this formulary item
... status ?!Σ 1..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... category 0..* CodeableConcept Categorization of this formulary item
... subject Σ 1..1 CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) Information that this item is about
... author 0..1 ContactDetail Creator or owner of the information about the item
... cost 0..* BackboneElement The pricing of the underlying item
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... specialPrecaution 0..* CodeableConcept Any precautions that affect the item
... monitoringProgram Σ 0..* BackboneElement Program under which a item is reviewed
.... type 0..1 CodeableConcept Type of program under which the item is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication
.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline
.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines
..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... associatedDocuments 0..* Reference(DocumentReference) Documents that provide more information about the item
... characteristic 0..* BackboneElement Specifies descriptive properties of the item
.... type 1..1 CodeableConcept Code specifying the type of characteristic of item
.... value[x] 1..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
... availabilityStatus 0..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... availabilityPeriod 0..1 Period Time period of the availability of the item
... coverageInformation 0..* BackboneElement Specific coverage information about the item
.... type 1..1 CodeableConcept Code specifying the type of coverage information
.... coverage 1..1 Reference(Coverage) Description of the coverage
... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
.... type 1..1 CodeableConcept Specifies the type of substitution allowed
.... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
.... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
.... period 0..1 Duration The period that applies to the maximum number of units
... associatedItems 0..* BackboneElement Associated or related formulary items
.... type 1..1 CodeableConcept Category of formulary item
.... reference 1..1 Reference(Formulary Item) Associated items about the formulary item

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
FormularyItem.status Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.cost.cost[x] Base example Medication Cost Category Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.availabilityStatus Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FormularyItem 0..* DomainResource Definition of a FormularyItem

Elements defined in Ancestors:id, meta, implicitRules, language, text, contained, extension, modifierExtension
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ 0..* Identifier Business identifier for this formulary item
... status ?!Σ 1..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... category 0..* CodeableConcept Categorization of this formulary item
... context Σ 0..1 CodeableReference(Organization | InsurancePlan) Owner of the formulary that this item was created for
... subject Σ 1..1 CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) Information that this item is about
... author 0..1 ContactDetail Creator or owner of the information about the item
... cost 0..* BackboneElement The pricing of the underlying item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... effectiveDate 0..* Period The date range for which the cost is effective
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost[x] 1..1 The price or category of the cost of the medication
Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication.
..... costMoney Money
..... costCodeableConcept CodeableConcept
... specialPrecaution 0..* CodeableConcept Any precautions that affect the item
... monitoringProgram Σ 0..* BackboneElement Program under which a item is reviewed
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the item is monitored
.... name 0..1 string Name of the reviewing program
... indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline
.... dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... treatmentIntent 0..1 CodeableConcept Intention of the treatment
..... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Category of dosage for a medication
...... dosage 1..* Dosage Dosage for the medication for the specific guidelines
..... administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to
..... patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline
...... value[x] 0..1 The specific characteristic
....... valueCodeableConcept CodeableConcept
....... valueQuantity Quantity
....... valueRange Range
... associatedDocuments 0..* Reference(DocumentReference) Documents that provide more information about the item
... characteristic 0..* BackboneElement Specifies descriptive properties of the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of characteristic of item
.... value[x] 1..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
..... valueAttachment Attachment
... availabilityStatus 0..1 code active | entered-in-error | inactive
Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use.
... availabilityPeriod 0..1 Period Time period of the availability of the item
... coverageInformation 0..* BackboneElement Specific coverage information about the item
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Code specifying the type of coverage information
.... coverage 1..1 Reference(Coverage) Description of the coverage
... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Specifies the type of substitution allowed
.... allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing
... schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction
... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed
.... period 0..1 Duration The period that applies to the maximum number of units
... associatedItems 0..* BackboneElement Associated or related formulary items
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category of formulary item
.... reference 1..1 Reference(Formulary Item) Associated items about the formulary item

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
FormularyItem.language Base required All Languages 📍6.0.0-ballot3 FHIR Std.
FormularyItem.status Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.cost.cost[x] Base example Medication Cost Category Codes 📦6.0.0-ballot3 FHIR Std.
FormularyItem.availabilityStatus Base required FormularyItem Status Codes 📦6.0.0-ballot3 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error FormularyItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error FormularyItem If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
dom-4 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error FormularyItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice FormularyItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from DomainResource

Summary

Mandatory: 0 element(16 nested mandatory elements)

Structures

This structure refers to these other structures:

Maturity: 0

 

​Other representations of profile: CSV, Excel, Schematron

Notes: