Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

11.11 Resource FormularyItem - Content

Pharmacy icon Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any 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, eg. 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 TUDomainResourceDefinition of a FormularyItem

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier for this formulary item

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

doco Documentation for this format

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

Changes since R4

This resource did not exist in Release 3

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. FormularyItem TUDomainResourceDefinition of a FormularyItem

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... identifier Σ0..*IdentifierBusiness identifier for this formulary item

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

doco Documentation for this format

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

Changes since Release 4

This resource did not exist in Release 3

This analysis is available 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

PathDefinitionTypeReference
FormularyItem.code

This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set.

ExampleSNOMEDCTMedicationCodes
FormularyItem.status

FormularyItem Status Codes

RequiredFormularyItem Status Codes

11.11.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
codetokenReturns formulary items for a specific codeFormularyItem.code
identifiertokenReturns formulary items with this external identifierFormularyItem.identifier