FHIR CI-Build

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 icon Work GroupMaturity Level: 0 Trial UseSecurity 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

No references for this Resource.

11.11.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

... code Σ 0..1 CodeableConcept Codes that identify this formulary item
Binding: SNOMED CT Medication Codes (Example)
... status ?!Σ 0..1 code active | entered-in-error | inactive
Binding: FormularyItem Status Codes (Required)

doco Documentation for this format icon

See the Extensions for this resource

XML Template

<FormularyItem xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this formulary item --></identifier>
 <code><!-- 0..1 CodeableConcept Codes that identify this formulary item --></code>
 <status value="[code]"/><!-- 0..1 active | entered-in-error | inactive -->
</FormularyItem>

Turtle Template

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


[ 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:code [ CodeableConcept ] ; # 0..1 Codes that identify this formulary item
  fhir:status [ code ] ; # 0..1 active | entered-in-error | inactive
]

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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

... code Σ 0..1 CodeableConcept Codes that identify this formulary item
Binding: SNOMED CT Medication Codes (Example)
... status ?!Σ 0..1 code active | entered-in-error | inactive
Binding: FormularyItem Status Codes (Required)

doco Documentation for this format icon

See the Extensions for this resource

XML Template

<FormularyItem xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Business identifier for this formulary item --></identifier>
 <code><!-- 0..1 CodeableConcept Codes that identify this formulary item --></code>
 <status value="[code]"/><!-- 0..1 active | entered-in-error | inactive -->
</FormularyItem>

Turtle Template

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


[ 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:code [ CodeableConcept ] ; # 0..1 Codes that identify this formulary item
  fhir:status [ code ] ; # 0..1 active | entered-in-error | inactive
]

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.code SNOMEDCTMedicationCodes Example

This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set.
FormularyItem.status 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
code token Returns formulary items for a specific code FormularyItem.code
identifier token Returns formulary items with this external identifier FormularyItem.identifier