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

11.11 Resource FormularyItem - Content

Pharmacy

Work Group

Maturity Level: 0

Trial Use

Security Category: Business

Compartments: No defined compartments

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.

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

11.11.2 References to this Resource

Resource References: itself

Structure

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
FormularyItem	TU		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: FormularyItem Status Codes (Required)
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 \| MedicinalProductDefinition \| 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: Medication Cost Category Codes (Example)
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()	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			SimpleQuantity
valueBase64Binary			base64Binary
valueAttachment			Attachment
availabilityStatus		0..1	code	active \| entered-in-error \| inactive Binding: FormularyItem Status Codes (Required)
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()	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(FormularyItem)	Associated items about the formulary item
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<FormularyItem xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this formulary item --></identifier>
 <status value="[code]"/><!-- 1..1 active | entered-in-error | inactive -->
 <category><!-- 0..* CodeableConcept Categorization of this formulary item --></category>
 <context><!-- 0..1 CodeableReference(InsurancePlan|Organization) Owner of the formulary that this item was created for --></context>
 <subject><!-- 1..1 CodeableReference(ActivityDefinition|DeviceDefinition|
   Medication|MedicinalProductDefinition|MedicinalProductDefinition|
   NutritionProduct|ObservationDefinition|PackagedProductDefinition) Information that this item is about --></subject>
 <author><!-- 0..1 ContactDetail Creator or owner of the information about the item --></author>
 <cost>  <!-- 0..* The pricing of the underlying item -->
  <effectiveDate><!-- 0..* Period The date range for which the cost is effective --></effectiveDate>
  <type><!-- 1..1 CodeableConcept The category of the cost information --></type>
  <source value="[string]"/><!-- 0..1 The source or owner for the price information -->
  <cost[x]><!-- 1..1 Money|CodeableConcept The price or category of the cost of the medication --></cost[x]>
 </cost>
 <specialPrecaution><!-- 0..* CodeableConcept Any precautions that affect the item --></specialPrecaution>
 <monitoringProgram>  <!-- 0..* Program under which a item is reviewed -->
  <type><!-- 0..1 CodeableConcept Type of program under which the item is monitored --></type>
  <name value="[string]"/><!-- 0..1 Name of the reviewing program -->
 </monitoringProgram>
 <indicationGuideline>  <!-- 0..* 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 --></indication>
  <dosingGuideline>  <!-- 0..* Guidelines for dosage of the medication -->
   <treatmentIntent><!-- 0..1 CodeableConcept Intention of the treatment --></treatmentIntent>
   <dosage>  <!-- 0..* Dosage for the medication for the specific guidelines -->
    <type><!-- 1..1 CodeableConcept Category of dosage for a medication --></type>
    <dosage><!-- 1..* Dosage Dosage for the medication for the specific guidelines --></dosage>
   </dosage>
   <administrationTreatment><!-- 0..1 CodeableConcept Type of treatment the guideline applies to --></administrationTreatment>
   <patientCharacteristic>  <!-- 0..* 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 --></type>
    <value[x]><!-- 0..1 CodeableConcept|Quantity|Range The specific characteristic --></value[x]>
   </patientCharacteristic>
  </dosingGuideline>
 </indicationGuideline>
 <associatedDocuments><!-- 0..* Reference Documents that provide more information about the item --></associatedDocuments>
 <characteristic>  <!-- 0..* Specifies descriptive properties of the item -->
  <type><!-- 1..1 CodeableConcept Code specifying the type of characteristic of item --></type>
  <value[x]><!-- 1..1 CodeableConcept|string|Quantity(SimpleQuantity)|
    base64Binary|Attachment Description of the characteristic --></value[x]>
 </characteristic>
 <availabilityStatus value="[code]"/><!-- 0..1 active | entered-in-error | inactive -->
 <availabilityPeriod><!-- 0..1 Period Time period of the availability of the item --></availabilityPeriod>
 <coverageInformation>  <!-- 0..* Specific coverage information about the item -->
  <type><!-- 1..1 CodeableConcept Code specifying the type of coverage information --></type>
  <coverage><!-- 1..1 Reference Description of the coverage --></coverage>
 </coverageInformation>
 <substitution>  <!-- 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective -->
  <type><!-- 1..1 CodeableConcept Specifies the type of substitution allowed --></type>
  <allowed value="[boolean]"/><!-- 1..1 Specifies if regulation allows for changes in the medication when dispensing -->
 </substitution>
 <schedule><!-- 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction --></schedule>
 <maxDispense>  <!-- 0..1 The maximum number of units of the medication that can be dispensed in a period -->
  <quantity><!-- 1..1 Quantity(SimpleQuantity) The maximum number of units of the medication that can be dispensed --></quantity>
  <period><!-- 0..1 Duration The period that applies to the maximum number of units --></period>
 </maxDispense>
 <associatedItems>  <!-- 0..* Associated or related formulary items -->
  <type><!-- 1..1 CodeableConcept Category of formulary item --></type>
  <reference><!-- 1..1 Reference(FormularyItem) Associated items about the formulary item --></reference>
 </associatedItems>
</FormularyItem>

JSON Template

{
  "resourceType" : "FormularyItem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for this formulary item
  "status" : "<code>", // R!  active | entered-in-error | inactive
  "category" : [{ CodeableConcept }], // Categorization of this formulary item
  "context" : { CodeableReference(InsurancePlan|Organization) }, // Owner of the formulary that this item was created for
  "subject" : { CodeableReference(ActivityDefinition|DeviceDefinition|
   Medication|MedicinalProductDefinition|MedicinalProductDefinition|
   NutritionProduct|ObservationDefinition|PackagedProductDefinition) }, // R!  Information that this item is about
  "author" : { ContactDetail }, // Creator or owner of the information about the item
  "cost" : [{ // The pricing of the underlying item
    "effectiveDate" : [{ Period }], // The date range for which the cost is effective
    "type" : { CodeableConcept }, // R!  The category of the cost information
    "source" : "<string>", // The source or owner for the price information
    // cost[x]: The price or category of the cost of the medication. One of these 2:
    "costMoney" : { Money },
    "costCodeableConcept" : { CodeableConcept }
  }],
  "specialPrecaution" : [{ CodeableConcept }], // Any precautions that affect the item
  "monitoringProgram" : [{ // Program under which a item is reviewed
    "type" : { CodeableConcept }, // Type of program under which the item is monitored
    "name" : "<string>" // Name of the reviewing program
  }],
  "indicationGuideline" : [{ // Guidelines or protocols for administration of the medication for an indication
    "indication" : [{ CodeableReference(ClinicalUseDefinition) }], // Indication for use that applies to the specific administration guideline
    "dosingGuideline" : [{ // Guidelines for dosage of the medication
      "treatmentIntent" : { CodeableConcept }, // Intention of the treatment
      "dosage" : [{ // Dosage for the medication for the specific guidelines
        "type" : { CodeableConcept }, // R!  Category of dosage for a medication
        "dosage" : [{ Dosage }] // R!  Dosage for the medication for the specific guidelines
      }],
      "administrationTreatment" : { CodeableConcept }, // Type of treatment the guideline applies to
      "patientCharacteristic" : [{ // Characteristics of the patient that are relevant to the administration guidelines
        "type" : { CodeableConcept }, // R!  Categorization of specific characteristic that is relevant to the administration guideline
        // value[x]: The specific characteristic. One of these 3:
        "valueCodeableConcept" : { CodeableConcept },
        "valueQuantity" : { Quantity },
        "valueRange" : { Range }
      }]
    }]
  }],
  "associatedDocuments" : [{ Reference }], // Documents that provide more information about the item
  "characteristic" : [{ // Specifies descriptive properties of the item
    "type" : { CodeableConcept }, // R!  Code specifying the type of characteristic of item
    // value[x]: Description of the characteristic. One of these 5:
    "valueCodeableConcept" : { CodeableConcept },
    "valueString" : "<string>",
    "valueQuantity" : { Quantity(SimpleQuantity) },
    "valueBase64Binary" : "<base64Binary>",
    "valueAttachment" : { Attachment }
  }],
  "availabilityStatus" : "<code>", // active | entered-in-error | inactive
  "availabilityPeriod" : { Period }, // Time period of the availability of the item
  "coverageInformation" : [{ // Specific coverage information about the item
    "type" : { CodeableConcept }, // R!  Code specifying the type of coverage information
    "coverage" : { Reference } // R!  Description of the coverage
  }],
  "substitution" : [{ // Specifies if changes are allowed when dispensing a medication from a regulatory perspective
    "type" : { CodeableConcept }, // R!  Specifies the type of substitution allowed
    "allowed" : <boolean> // R!  Specifies if regulation allows for changes in the medication when dispensing
  }],
  "schedule" : [{ CodeableConcept }], // Specifies the schedule of a medication in jurisdiction
  "maxDispense" : { // The maximum number of units of the medication that can be dispensed in a period
    "quantity" : { Quantity(SimpleQuantity) }, // R!  The maximum number of units of the medication that can be dispensed
    "period" : { Duration } // The period that applies to the maximum number of units
  },
  "associatedItems" : [{ // Associated or related formulary items
    "type" : { CodeableConcept }, // R!  Category of formulary item
    "reference" : { Reference(FormularyItem) } // R!  Associated items about the formulary item
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:FormularyItem;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this formulary item
  fhir:status [ code ] ; # 1..1 active | entered-in-error | inactive
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Categorization of this formulary item
  fhir:context [ CodeableReference(InsurancePlan|Organization) ] ; # 0..1 Owner of the formulary that this item was created for
  fhir:subject [ CodeableReference(ActivityDefinition|DeviceDefinition|Medication|MedicinalProductDefinition|
  MedicinalProductDefinition|NutritionProduct|ObservationDefinition|
  PackagedProductDefinition) ] ; # 1..1 Information that this item is about
  fhir:author [ ContactDetail ] ; # 0..1 Creator or owner of the information about the item
  fhir:cost ( [ # 0..* The pricing of the underlying item
    fhir:effectiveDate  ( [ Period ] ... ) ; # 0..* The date range for which the cost is effective
    fhir:type [ CodeableConcept ] ; # 1..1 The category of the cost information
    fhir:source [ string ] ; # 0..1 The source or owner for the price information
    # cost[x] : 1..1 The price or category of the cost of the medication. One of these 2
      fhir:cost [  a fhir:Money ; Money ]
      fhir:cost [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  fhir:specialPrecaution  ( [ CodeableConcept ] ... ) ; # 0..* Any precautions that affect the item
  fhir:monitoringProgram ( [ # 0..* Program under which a item is reviewed
    fhir:type [ CodeableConcept ] ; # 0..1 Type of program under which the item is monitored
    fhir:name [ string ] ; # 0..1 Name of the reviewing program
  ] ... ) ;
  fhir:indicationGuideline ( [ # 0..* Guidelines or protocols for administration of the medication for an indication
    fhir:indication  ( [ CodeableReference(ClinicalUseDefinition) ] ... ) ; # 0..* Indication for use that applies to the specific administration guideline
    fhir:dosingGuideline ( [ # 0..* Guidelines for dosage of the medication
      fhir:treatmentIntent [ CodeableConcept ] ; # 0..1 Intention of the treatment
      fhir:dosage ( [ # 0..* Dosage for the medication for the specific guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Category of dosage for a medication
        fhir:dosage  ( [ Dosage ] ... ) ; # 1..* Dosage for the medication for the specific guidelines
      ] ... ) ;
      fhir:administrationTreatment [ CodeableConcept ] ; # 0..1 Type of treatment the guideline applies to
      fhir:patientCharacteristic ( [ # 0..* Characteristics of the patient that are relevant to the administration guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Categorization of specific characteristic that is relevant to the administration guideline
        # value[x] : 0..1 The specific characteristic. One of these 3
          fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
          fhir:value [  a fhir:Quantity ; Quantity ]
          fhir:value [  a fhir:Range ; Range ]
      ] ... ) ;
    ] ... ) ;
  ] ... ) ;
  fhir:associatedDocuments  ( [ Reference ] ... ) ; # 0..* Documents that provide more information about the item
  fhir:characteristic ( [ # 0..* Specifies descriptive properties of the item
    fhir:type [ CodeableConcept ] ; # 1..1 Code specifying the type of characteristic of item
    # value[x] : 1..1 Description of the characteristic. One of these 5
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:string ; string ]
      fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
      fhir:value [  a fhir:base64Binary ; base64Binary ]
      fhir:value [  a fhir:Attachment ; Attachment ]
  ] ... ) ;
  fhir:availabilityStatus [ code ] ; # 0..1 active | entered-in-error | inactive
  fhir:availabilityPeriod [ Period ] ; # 0..1 Time period of the availability of the item
  fhir:coverageInformation ( [ # 0..* Specific coverage information about the item
    fhir:type [ CodeableConcept ] ; # 1..1 Code specifying the type of coverage information
    fhir:coverage [ Reference ] ; # 1..1 Description of the coverage
  ] ... ) ;
  fhir:substitution ( [ # 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective
    fhir:type [ CodeableConcept ] ; # 1..1 Specifies the type of substitution allowed
    fhir:allowed [ boolean ] ; # 1..1 Specifies if regulation allows for changes in the medication when dispensing
  ] ... ) ;
  fhir:schedule  ( [ CodeableConcept ] ... ) ; # 0..* Specifies the schedule of a medication in jurisdiction
  fhir:maxDispense [ # 0..1 The maximum number of units of the medication that can be dispensed in a period
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 1..1 The maximum number of units of the medication that can be dispensed
    fhir:period [ Duration ] ; # 0..1 The period that applies to the maximum number of units
  ] ;
  fhir:associatedItems ( [ # 0..* Associated or related formulary items
    fhir:type [ CodeableConcept ] ; # 1..1 Category of formulary item
    fhir:reference [ Reference(FormularyItem) ] ; # 1..1 Associated items about the formulary item
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
FormularyItem	TU		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: FormularyItem Status Codes (Required)
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 \| MedicinalProductDefinition \| 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: Medication Cost Category Codes (Example)
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()	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			SimpleQuantity
valueBase64Binary			base64Binary
valueAttachment			Attachment
availabilityStatus		0..1	code	active \| entered-in-error \| inactive Binding: FormularyItem Status Codes (Required)
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()	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(FormularyItem)	Associated items about the formulary item
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<FormularyItem xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this formulary item --></identifier>
 <status value="[code]"/><!-- 1..1 active | entered-in-error | inactive -->
 <category><!-- 0..* CodeableConcept Categorization of this formulary item --></category>
 <context><!-- 0..1 CodeableReference(InsurancePlan|Organization) Owner of the formulary that this item was created for --></context>
 <subject><!-- 1..1 CodeableReference(ActivityDefinition|DeviceDefinition|
   Medication|MedicinalProductDefinition|MedicinalProductDefinition|
   NutritionProduct|ObservationDefinition|PackagedProductDefinition) Information that this item is about --></subject>
 <author><!-- 0..1 ContactDetail Creator or owner of the information about the item --></author>
 <cost>  <!-- 0..* The pricing of the underlying item -->
  <effectiveDate><!-- 0..* Period The date range for which the cost is effective --></effectiveDate>
  <type><!-- 1..1 CodeableConcept The category of the cost information --></type>
  <source value="[string]"/><!-- 0..1 The source or owner for the price information -->
  <cost[x]><!-- 1..1 Money|CodeableConcept The price or category of the cost of the medication --></cost[x]>
 </cost>
 <specialPrecaution><!-- 0..* CodeableConcept Any precautions that affect the item --></specialPrecaution>
 <monitoringProgram>  <!-- 0..* Program under which a item is reviewed -->
  <type><!-- 0..1 CodeableConcept Type of program under which the item is monitored --></type>
  <name value="[string]"/><!-- 0..1 Name of the reviewing program -->
 </monitoringProgram>
 <indicationGuideline>  <!-- 0..* 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 --></indication>
  <dosingGuideline>  <!-- 0..* Guidelines for dosage of the medication -->
   <treatmentIntent><!-- 0..1 CodeableConcept Intention of the treatment --></treatmentIntent>
   <dosage>  <!-- 0..* Dosage for the medication for the specific guidelines -->
    <type><!-- 1..1 CodeableConcept Category of dosage for a medication --></type>
    <dosage><!-- 1..* Dosage Dosage for the medication for the specific guidelines --></dosage>
   </dosage>
   <administrationTreatment><!-- 0..1 CodeableConcept Type of treatment the guideline applies to --></administrationTreatment>
   <patientCharacteristic>  <!-- 0..* 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 --></type>
    <value[x]><!-- 0..1 CodeableConcept|Quantity|Range The specific characteristic --></value[x]>
   </patientCharacteristic>
  </dosingGuideline>
 </indicationGuideline>
 <associatedDocuments><!-- 0..* Reference Documents that provide more information about the item --></associatedDocuments>
 <characteristic>  <!-- 0..* Specifies descriptive properties of the item -->
  <type><!-- 1..1 CodeableConcept Code specifying the type of characteristic of item --></type>
  <value[x]><!-- 1..1 CodeableConcept|string|Quantity(SimpleQuantity)|
    base64Binary|Attachment Description of the characteristic --></value[x]>
 </characteristic>
 <availabilityStatus value="[code]"/><!-- 0..1 active | entered-in-error | inactive -->
 <availabilityPeriod><!-- 0..1 Period Time period of the availability of the item --></availabilityPeriod>
 <coverageInformation>  <!-- 0..* Specific coverage information about the item -->
  <type><!-- 1..1 CodeableConcept Code specifying the type of coverage information --></type>
  <coverage><!-- 1..1 Reference Description of the coverage --></coverage>
 </coverageInformation>
 <substitution>  <!-- 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective -->
  <type><!-- 1..1 CodeableConcept Specifies the type of substitution allowed --></type>
  <allowed value="[boolean]"/><!-- 1..1 Specifies if regulation allows for changes in the medication when dispensing -->
 </substitution>
 <schedule><!-- 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction --></schedule>
 <maxDispense>  <!-- 0..1 The maximum number of units of the medication that can be dispensed in a period -->
  <quantity><!-- 1..1 Quantity(SimpleQuantity) The maximum number of units of the medication that can be dispensed --></quantity>
  <period><!-- 0..1 Duration The period that applies to the maximum number of units --></period>
 </maxDispense>
 <associatedItems>  <!-- 0..* Associated or related formulary items -->
  <type><!-- 1..1 CodeableConcept Category of formulary item --></type>
  <reference><!-- 1..1 Reference(FormularyItem) Associated items about the formulary item --></reference>
 </associatedItems>
</FormularyItem>

JSON Template

{
  "resourceType" : "FormularyItem",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Business identifier for this formulary item
  "status" : "<code>", // R!  active | entered-in-error | inactive
  "category" : [{ CodeableConcept }], // Categorization of this formulary item
  "context" : { CodeableReference(InsurancePlan|Organization) }, // Owner of the formulary that this item was created for
  "subject" : { CodeableReference(ActivityDefinition|DeviceDefinition|
   Medication|MedicinalProductDefinition|MedicinalProductDefinition|
   NutritionProduct|ObservationDefinition|PackagedProductDefinition) }, // R!  Information that this item is about
  "author" : { ContactDetail }, // Creator or owner of the information about the item
  "cost" : [{ // The pricing of the underlying item
    "effectiveDate" : [{ Period }], // The date range for which the cost is effective
    "type" : { CodeableConcept }, // R!  The category of the cost information
    "source" : "<string>", // The source or owner for the price information
    // cost[x]: The price or category of the cost of the medication. One of these 2:
    "costMoney" : { Money },
    "costCodeableConcept" : { CodeableConcept }
  }],
  "specialPrecaution" : [{ CodeableConcept }], // Any precautions that affect the item
  "monitoringProgram" : [{ // Program under which a item is reviewed
    "type" : { CodeableConcept }, // Type of program under which the item is monitored
    "name" : "<string>" // Name of the reviewing program
  }],
  "indicationGuideline" : [{ // Guidelines or protocols for administration of the medication for an indication
    "indication" : [{ CodeableReference(ClinicalUseDefinition) }], // Indication for use that applies to the specific administration guideline
    "dosingGuideline" : [{ // Guidelines for dosage of the medication
      "treatmentIntent" : { CodeableConcept }, // Intention of the treatment
      "dosage" : [{ // Dosage for the medication for the specific guidelines
        "type" : { CodeableConcept }, // R!  Category of dosage for a medication
        "dosage" : [{ Dosage }] // R!  Dosage for the medication for the specific guidelines
      }],
      "administrationTreatment" : { CodeableConcept }, // Type of treatment the guideline applies to
      "patientCharacteristic" : [{ // Characteristics of the patient that are relevant to the administration guidelines
        "type" : { CodeableConcept }, // R!  Categorization of specific characteristic that is relevant to the administration guideline
        // value[x]: The specific characteristic. One of these 3:
        "valueCodeableConcept" : { CodeableConcept },
        "valueQuantity" : { Quantity },
        "valueRange" : { Range }
      }]
    }]
  }],
  "associatedDocuments" : [{ Reference }], // Documents that provide more information about the item
  "characteristic" : [{ // Specifies descriptive properties of the item
    "type" : { CodeableConcept }, // R!  Code specifying the type of characteristic of item
    // value[x]: Description of the characteristic. One of these 5:
    "valueCodeableConcept" : { CodeableConcept },
    "valueString" : "<string>",
    "valueQuantity" : { Quantity(SimpleQuantity) },
    "valueBase64Binary" : "<base64Binary>",
    "valueAttachment" : { Attachment }
  }],
  "availabilityStatus" : "<code>", // active | entered-in-error | inactive
  "availabilityPeriod" : { Period }, // Time period of the availability of the item
  "coverageInformation" : [{ // Specific coverage information about the item
    "type" : { CodeableConcept }, // R!  Code specifying the type of coverage information
    "coverage" : { Reference } // R!  Description of the coverage
  }],
  "substitution" : [{ // Specifies if changes are allowed when dispensing a medication from a regulatory perspective
    "type" : { CodeableConcept }, // R!  Specifies the type of substitution allowed
    "allowed" : <boolean> // R!  Specifies if regulation allows for changes in the medication when dispensing
  }],
  "schedule" : [{ CodeableConcept }], // Specifies the schedule of a medication in jurisdiction
  "maxDispense" : { // The maximum number of units of the medication that can be dispensed in a period
    "quantity" : { Quantity(SimpleQuantity) }, // R!  The maximum number of units of the medication that can be dispensed
    "period" : { Duration } // The period that applies to the maximum number of units
  },
  "associatedItems" : [{ // Associated or related formulary items
    "type" : { CodeableConcept }, // R!  Category of formulary item
    "reference" : { Reference(FormularyItem) } // R!  Associated items about the formulary item
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:FormularyItem;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Business identifier for this formulary item
  fhir:status [ code ] ; # 1..1 active | entered-in-error | inactive
  fhir:category  ( [ CodeableConcept ] ... ) ; # 0..* Categorization of this formulary item
  fhir:context [ CodeableReference(InsurancePlan|Organization) ] ; # 0..1 Owner of the formulary that this item was created for
  fhir:subject [ CodeableReference(ActivityDefinition|DeviceDefinition|Medication|MedicinalProductDefinition|
  MedicinalProductDefinition|NutritionProduct|ObservationDefinition|
  PackagedProductDefinition) ] ; # 1..1 Information that this item is about
  fhir:author [ ContactDetail ] ; # 0..1 Creator or owner of the information about the item
  fhir:cost ( [ # 0..* The pricing of the underlying item
    fhir:effectiveDate  ( [ Period ] ... ) ; # 0..* The date range for which the cost is effective
    fhir:type [ CodeableConcept ] ; # 1..1 The category of the cost information
    fhir:source [ string ] ; # 0..1 The source or owner for the price information
    # cost[x] : 1..1 The price or category of the cost of the medication. One of these 2
      fhir:cost [  a fhir:Money ; Money ]
      fhir:cost [  a fhir:CodeableConcept ; CodeableConcept ]
  ] ... ) ;
  fhir:specialPrecaution  ( [ CodeableConcept ] ... ) ; # 0..* Any precautions that affect the item
  fhir:monitoringProgram ( [ # 0..* Program under which a item is reviewed
    fhir:type [ CodeableConcept ] ; # 0..1 Type of program under which the item is monitored
    fhir:name [ string ] ; # 0..1 Name of the reviewing program
  ] ... ) ;
  fhir:indicationGuideline ( [ # 0..* Guidelines or protocols for administration of the medication for an indication
    fhir:indication  ( [ CodeableReference(ClinicalUseDefinition) ] ... ) ; # 0..* Indication for use that applies to the specific administration guideline
    fhir:dosingGuideline ( [ # 0..* Guidelines for dosage of the medication
      fhir:treatmentIntent [ CodeableConcept ] ; # 0..1 Intention of the treatment
      fhir:dosage ( [ # 0..* Dosage for the medication for the specific guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Category of dosage for a medication
        fhir:dosage  ( [ Dosage ] ... ) ; # 1..* Dosage for the medication for the specific guidelines
      ] ... ) ;
      fhir:administrationTreatment [ CodeableConcept ] ; # 0..1 Type of treatment the guideline applies to
      fhir:patientCharacteristic ( [ # 0..* Characteristics of the patient that are relevant to the administration guidelines
        fhir:type [ CodeableConcept ] ; # 1..1 Categorization of specific characteristic that is relevant to the administration guideline
        # value[x] : 0..1 The specific characteristic. One of these 3
          fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
          fhir:value [  a fhir:Quantity ; Quantity ]
          fhir:value [  a fhir:Range ; Range ]
      ] ... ) ;
    ] ... ) ;
  ] ... ) ;
  fhir:associatedDocuments  ( [ Reference ] ... ) ; # 0..* Documents that provide more information about the item
  fhir:characteristic ( [ # 0..* Specifies descriptive properties of the item
    fhir:type [ CodeableConcept ] ; # 1..1 Code specifying the type of characteristic of item
    # value[x] : 1..1 Description of the characteristic. One of these 5
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:string ; string ]
      fhir:value [  a fhir:SimpleQuantity ; Quantity(SimpleQuantity) ]
      fhir:value [  a fhir:base64Binary ; base64Binary ]
      fhir:value [  a fhir:Attachment ; Attachment ]
  ] ... ) ;
  fhir:availabilityStatus [ code ] ; # 0..1 active | entered-in-error | inactive
  fhir:availabilityPeriod [ Period ] ; # 0..1 Time period of the availability of the item
  fhir:coverageInformation ( [ # 0..* Specific coverage information about the item
    fhir:type [ CodeableConcept ] ; # 1..1 Code specifying the type of coverage information
    fhir:coverage [ Reference ] ; # 1..1 Description of the coverage
  ] ... ) ;
  fhir:substitution ( [ # 0..* Specifies if changes are allowed when dispensing a medication from a regulatory perspective
    fhir:type [ CodeableConcept ] ; # 1..1 Specifies the type of substitution allowed
    fhir:allowed [ boolean ] ; # 1..1 Specifies if regulation allows for changes in the medication when dispensing
  ] ... ) ;
  fhir:schedule  ( [ CodeableConcept ] ... ) ; # 0..* Specifies the schedule of a medication in jurisdiction
  fhir:maxDispense [ # 0..1 The maximum number of units of the medication that can be dispensed in a period
    fhir:quantity [ Quantity(SimpleQuantity) ] ; # 1..1 The maximum number of units of the medication that can be dispensed
    fhir:period [ Duration ] ; # 0..1 The period that applies to the maximum number of units
  ] ;
  fhir:associatedItems ( [ # 0..* Associated or related formulary items
    fhir:type [ CodeableConcept ] ; # 1..1 Category of formulary item
    fhir:reference [ Reference(FormularyItem) ] ; # 1..1 Associated items about the formulary item
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

11.11.3.1 Terminology Bindings

Path	ValueSet	Type	Documentation
FormularyItem.status	FormularyItemStatusCodes	Required	FormularyItem Status Codes
FormularyItem.cost.cost[x]	MedicationCostCategoryCodes	Example	Medication Cost Category Codes
FormularyItem.availabilityStatus	FormularyItemStatusCodes	Required	FormularyItem Status Codes

Path

ValueSet

Type

Documentation

FormularyItem.status

FormularyItemStatusCodes

Required

FormularyItem Status Codes

FormularyItem.cost.cost[x]

MedicationCostCategoryCodes

Example

Medication Cost Category Codes

FormularyItem.availabilityStatus

FormularyItemStatusCodes

Required

FormularyItem Status Codes

11.11.4 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
identifier	token	Returns formulary items with this external identifier	FormularyItem.identifier