DaVinci Payer Data Exchange (PDex) US Drug Formulary | STU2 Ballot
1.2.0 - STU2 Ballot

This page is part of the US Drug Formulary (v1.2.0: STU 2 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Formulary

Defining URL:http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
Version:1.2.0
Name:Formulary
Status:Active as of 12/3/21 6:37 PM
Definition:

The Formulary provides general information about a formulary and acts as an organizing construct that associated FormularyItem resources point to. The Formulary combined with its associated FormularyItem and FormularyDrug resources represent a formulary list that includes the set of drugs covered and the requirements and limitations of the coverage.

Publisher:HL7 Pharmacy Working Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary

Formal Views of Profile Content

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

This structure is derived from InsurancePlan

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 5 elements

This structure is derived from InsurancePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. InsurancePlan 0..*InsurancePlanDetails of a Health Insurance product/plan provided by an organization
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... identifier S1..*IdentifierBusiness Identifier for Product
... status S1..1codedraft | active | retired | unknown
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
... name S0..1stringOfficial name
... period S0..1PeriodWhen the product is available
... plan 0..1BackboneElementOptional non-cost related plan information indicating pharmacy network types and drug tiers available in the formulary
.... type 1..1CodeableConceptType of plan
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-PlanTypeCS
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: drug
.... specificCost 0..*BackboneElementPharmacy network type specific cost
..... category 1..1CodeableConceptGeneral category of benefit
Binding: Type of pharmacies (extensible)
..... benefit 0..*BackboneElementDrug tier benefit
...... type 1..1CodeableConceptType of specific benefit
Binding: Drug tier of medication in health plan (extensible)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. InsurancePlan I0..*InsurancePlanDetails of a Health Insurance product/plan provided by an organization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*IdentifierBusiness Identifier for Product
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type SΣ1..1CodeableConceptPlan type
Binding: InsurancePlanType (example): Used to categorize the product/plan.



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... name SΣI0..1stringOfficial name
... alias 0..*stringAlternate names
... period S0..1PeriodWhen the product is available
... ownedBy Σ0..1Reference(Organization)Plan issuer
... administeredBy Σ0..1Reference(Organization)Product administrator
... coverageArea Σ0..*Reference(Location)Where product applies
... contact 0..*BackboneElementContact for the product
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoint
... network 0..*Reference(Organization)What networks are Included
... coverage 0..*BackboneElementCoverage details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptType of coverage
.... network 0..*Reference(Organization)What networks provide coverage
.... benefit 1..*BackboneElementList of benefits
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptType of benefit
..... requirement 0..1stringReferral requirements
..... limit 0..*BackboneElementBenefit limits
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... value 0..1QuantityMaximum value allowed
...... code 0..1CodeableConceptBenefit limit details
... plan 0..1BackboneElementOptional non-cost related plan information indicating pharmacy network types and drug tiers available in the formulary
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierBusiness Identifier for Product
.... type 1..1CodeableConceptType of plan
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-PlanTypeCS
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: drug
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... coverageArea Σ0..*Reference(Location)Where product applies
.... network 0..*Reference(Organization)What networks provide coverage
.... generalCost 0..*BackboneElementOverall costs
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptType of cost
..... groupSize 0..1positiveIntNumber of enrollees
..... cost 0..1MoneyCost value
..... comment 0..1stringAdditional cost information
.... specificCost 0..*BackboneElementPharmacy network type specific cost
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category 1..1CodeableConceptGeneral category of benefit
Binding: Type of pharmacies (extensible)
..... benefit 0..*BackboneElementDrug tier benefit
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1CodeableConceptType of specific benefit
Binding: Drug tier of medication in health plan (extensible)
...... cost 0..*BackboneElementList of the costs
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1CodeableConceptType of cost
....... applicability 0..1CodeableConceptin-network | out-of-network | other
Binding: BenefitCostApplicability (required): Whether the cost applies to in-network or out-of-network providers.

....... qualifiers 0..*CodeableConceptAdditional information about the cost
....... value 0..1QuantityThe actual cost value

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. InsurancePlan I0..*InsurancePlanDetails of a Health Insurance product/plan provided by an organization
... identifier ΣI1..*IdentifierBusiness Identifier for Product
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type Σ1..1CodeableConceptPlan type
Binding: InsurancePlanType (example): Used to categorize the product/plan.



Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
... period 0..1PeriodWhen the product is available

doco Documentation for this format

This structure is derived from InsurancePlan

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 5 elements

Differential View

This structure is derived from InsurancePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. InsurancePlan 0..*InsurancePlanDetails of a Health Insurance product/plan provided by an organization
... meta
.... lastUpdated 1..1instantWhen the resource version last changed
... identifier S1..*IdentifierBusiness Identifier for Product
... status S1..1codedraft | active | retired | unknown
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
... name S0..1stringOfficial name
... period S0..1PeriodWhen the product is available
... plan 0..1BackboneElementOptional non-cost related plan information indicating pharmacy network types and drug tiers available in the formulary
.... type 1..1CodeableConceptType of plan
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-PlanTypeCS
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: drug
.... specificCost 0..*BackboneElementPharmacy network type specific cost
..... category 1..1CodeableConceptGeneral category of benefit
Binding: Type of pharmacies (extensible)
..... benefit 0..*BackboneElementDrug tier benefit
...... type 1..1CodeableConceptType of specific benefit
Binding: Drug tier of medication in health plan (extensible)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. InsurancePlan I0..*InsurancePlanDetails of a Health Insurance product/plan provided by an organization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ0..*canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*IdentifierBusiness Identifier for Product
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type SΣ1..1CodeableConceptPlan type
Binding: InsurancePlanType (example): Used to categorize the product/plan.



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: DRUGPOL
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... name SΣI0..1stringOfficial name
... alias 0..*stringAlternate names
... period S0..1PeriodWhen the product is available
... ownedBy Σ0..1Reference(Organization)Plan issuer
... administeredBy Σ0..1Reference(Organization)Product administrator
... coverageArea Σ0..*Reference(Location)Where product applies
... contact 0..*BackboneElementContact for the product
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoint
... network 0..*Reference(Organization)What networks are Included
... coverage 0..*BackboneElementCoverage details
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type 1..1CodeableConceptType of coverage
.... network 0..*Reference(Organization)What networks provide coverage
.... benefit 1..*BackboneElementList of benefits
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1CodeableConceptType of benefit
..... requirement 0..1stringReferral requirements
..... limit 0..*BackboneElementBenefit limits
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... value 0..1QuantityMaximum value allowed
...... code 0..1CodeableConceptBenefit limit details
... plan 0..1BackboneElementOptional non-cost related plan information indicating pharmacy network types and drug tiers available in the formulary
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ0..*IdentifierBusiness Identifier for Product
.... type 1..1CodeableConceptType of plan
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-PlanTypeCS
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: drug
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... coverageArea Σ0..*Reference(Location)Where product applies
.... network 0..*Reference(Organization)What networks provide coverage
.... generalCost 0..*BackboneElementOverall costs
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 0..1CodeableConceptType of cost
..... groupSize 0..1positiveIntNumber of enrollees
..... cost 0..1MoneyCost value
..... comment 0..1stringAdditional cost information
.... specificCost 0..*BackboneElementPharmacy network type specific cost
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... category 1..1CodeableConceptGeneral category of benefit
Binding: Type of pharmacies (extensible)
..... benefit 0..*BackboneElementDrug tier benefit
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... type 1..1CodeableConceptType of specific benefit
Binding: Drug tier of medication in health plan (extensible)
...... cost 0..*BackboneElementList of the costs
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1CodeableConceptType of cost
....... applicability 0..1CodeableConceptin-network | out-of-network | other
Binding: BenefitCostApplicability (required): Whether the cost applies to in-network or out-of-network providers.

....... qualifiers 0..*CodeableConceptAdditional information about the cost
....... value 0..1QuantityThe actual cost value

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
InsurancePlan.meta.securityextensibleAll Security Labels
InsurancePlan.meta.tagexampleCommonTags
InsurancePlan.languagepreferredCommonLanguages
Max Binding: AllLanguages
InsurancePlan.statusrequiredPublicationStatus
InsurancePlan.typeexamplePattern: DRUGPOL
InsurancePlan.contact.purposeextensibleContactEntityType
InsurancePlan.plan.specificCost.categoryextensiblePharmacyTypeVS
InsurancePlan.plan.specificCost.benefit.typeextensibleDrugTierVS
InsurancePlan.plan.specificCost.benefit.cost.applicabilityrequiredBenefitCostApplicability