DaVinci Payer Data Exchange (PDex) US Drug Formulary
1.0.1 - STU 1.0.1

This page is part of the US Drug Formulary (v1.0.1: STU 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 Drug

Defining URL:http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
Version:1.0.1
Name:FormularyDrug
Title:Formulary Drug
Status:Active as of 2020-12-21T16:49:28+00:00
Definition:

Drug information which is part of a formulary.

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-FormularyDrug

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge 0..*MedicationKnowledgeDefinition of Medication Knowledge
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... usdf-DrugAlternatives-extension 0..*Reference(Formulary Drug)Extension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugAlternatives-extension
... usdf-PriorAuthorization-extension S0..1booleanExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension
... usdf-StepTherapyLimit-extension S0..1booleanExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension
... usdf-QuantityLimit-extension S0..1booleanExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension
... usdf-PlanID-extension S1..1stringExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension
... usdf-DrugTierID-extension S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension
Binding: Drug tier of medication in health plan (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ1..1CodeableConceptCode that identifies this medication
Binding: US Core Medication Codes (RxNorm) (required)
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationKnowledge Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... doseForm 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount Σ0..1SimpleQuantityAmount of drug in package
... synonym Σ0..*stringAdditional names for a medication
... relatedMedicationKnowledge 0..*BackboneElementAssociated or related medication information
.... 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..1CodeableConceptCategory of medicationKnowledge
.... reference 1..*Reference(MedicationKnowledge)Associated documentation about the associated medication knowledge
... associatedMedication 0..*Reference(Medication)A medication resource that is associated with this medication
... productType 0..*CodeableConceptCategory of the medication or product
... monograph 0..*BackboneElementAssociated documentation about the medication
.... 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..1CodeableConceptThe category of medication document
.... source 0..1Reference(DocumentReference | Media)Associated documentation about the medication
... ingredient 0..*BackboneElementActive or inactive ingredient
.... 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
.... item[x] 1..1Medication(s) or substance(s) contained in the medication
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... preparationInstruction 0..1markdownThe instructions for preparing the medication
... intendedRoute 0..*CodeableConceptThe intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example): A coded concept defining the intended route of administration.


... cost 0..*BackboneElementThe pricing of the medication
.... 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..1CodeableConceptThe category of the cost information
.... source 0..1stringThe source or owner for the price information
.... cost 1..1MoneyThe price of the medication
... monitoringProgram 0..*BackboneElementProgram under which a medication is reviewed
.... 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 program under which the medication is monitored
.... name 0..1stringName of the reviewing program
... administrationGuidelines 0..*BackboneElementGuidelines for administration of the medication
.... 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
.... dosage 0..*BackboneElementDosage for the medication for the specific guidelines
..... 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 dosage
..... dosage 1..*DosageDosage for the medication for the specific guidelines
.... indication[x] 0..1Indication for use that apply to the specific administration guidelines
..... indicationCodeableConceptCodeableConcept
..... indicationReferenceReference(ObservationDefinition)
.... patientCharacteristics 0..*BackboneElementCharacteristics of the patient that are relevant to the administration guidelines
..... 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
..... characteristic[x] 1..1Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConceptCodeableConcept
...... characteristicQuantityQuantity(SimpleQuantity)
..... value 0..*stringThe specific characteristic
... medicineClassification 0..*BackboneElementCategorization of the medication within a formulary or classification system
.... 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..1CodeableConceptThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..*CodeableConceptSpecific category assigned to the medication
... packaging 0..1BackboneElementDetails about packaged medications
.... 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..1CodeableConceptA code that defines the specific type of packaging that the medication can be found in
Binding: medicationKnowledge Package Type Codes (example): A coded concept defining the type of packaging of a medication.

.... quantity 0..1SimpleQuantityThe number of product units the package would contain if fully loaded
... drugCharacteristic 0..*BackboneElementSpecifies descriptive properties of the medicine
.... 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..1CodeableConceptCode specifying the type of characteristic of medication
Binding: medicationKnowledge Characteristic Codes (example): A coded concept defining the characteristic types of a medication.

.... value[x] 0..1Description of the characteristic
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueQuantityQuantity(SimpleQuantity)
..... valueBase64Binarybase64Binary
... contraindication 0..*Reference(DetectedIssue)Potential clinical issue with or between medication(s)
... regulatory 0..*BackboneElementRegulatory information about a medication
.... 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
.... regulatoryAuthority 1..1Reference(Organization)Specifies the authority of the regulation
.... substitution 0..*BackboneElementSpecifies if changes are allowed when dispensing a medication from a regulatory perspective
..... 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..1CodeableConceptSpecifies the type of substitution allowed
..... allowed 1..1booleanSpecifies if regulation allows for changes in the medication when dispensing
.... schedule 0..*BackboneElementSpecifies the schedule of a medication in jurisdiction
..... 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
..... schedule 1..1CodeableConceptSpecifies the specific drug schedule
.... maxDispense 0..1BackboneElementThe maximum number of units of the medication that can be dispensed in a period
..... 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
..... quantity 1..1SimpleQuantityThe maximum number of units of the medication that can be dispensed
..... period 0..1DurationThe period that applies to the maximum number of units
... kinetics 0..*BackboneElementThe time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... 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
.... areaUnderCurve 0..*SimpleQuantityThe drug concentration measured at certain discrete points in time
.... lethalDose50 0..*SimpleQuantityThe median lethal dose of a drug
.... halfLifePeriod 0..1DurationTime required for concentration in the body to decrease by half

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge 0..*MedicationKnowledgeDefinition of Medication Knowledge
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages: A human language.

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... usdf-DrugAlternatives-extension 0..*Reference(Formulary Drug)Extension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugAlternatives-extension
... usdf-PriorAuthorization-extension S0..1booleanExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension
... usdf-StepTherapyLimit-extension S0..1booleanExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension
... usdf-QuantityLimit-extension S0..1booleanExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension
... usdf-PlanID-extension S1..1stringExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension
... usdf-DrugTierID-extension S1..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension
Binding: Drug tier of medication in health plan (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code Σ1..1CodeableConceptCode that identifies this medication
Binding: US Core Medication Codes (RxNorm) (required)
... status ?!Σ0..1codeactive | inactive | entered-in-error
Binding: MedicationKnowledge Status Codes (required): A coded concept defining if the medication is in active use.

... manufacturer Σ0..1Reference(Organization)Manufacturer of the item
... doseForm 0..1CodeableConceptpowder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.

... amount Σ0..1SimpleQuantityAmount of drug in package
... synonym Σ0..*stringAdditional names for a medication
... relatedMedicationKnowledge 0..*BackboneElementAssociated or related medication information
.... 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..1CodeableConceptCategory of medicationKnowledge
.... reference 1..*Reference(MedicationKnowledge)Associated documentation about the associated medication knowledge
... associatedMedication 0..*Reference(Medication)A medication resource that is associated with this medication
... productType 0..*CodeableConceptCategory of the medication or product
... monograph 0..*BackboneElementAssociated documentation about the medication
.... 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..1CodeableConceptThe category of medication document
.... source 0..1Reference(DocumentReference | Media)Associated documentation about the medication
... ingredient 0..*BackboneElementActive or inactive ingredient
.... 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
.... item[x] 1..1Medication(s) or substance(s) contained in the medication
..... itemCodeableConceptCodeableConcept
..... itemReferenceReference(Substance)
.... isActive 0..1booleanActive ingredient indicator
.... strength 0..1RatioQuantity of ingredient present
... preparationInstruction 0..1markdownThe instructions for preparing the medication
... intendedRoute 0..*CodeableConceptThe intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example): A coded concept defining the intended route of administration.


... cost 0..*BackboneElementThe pricing of the medication
.... 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..1CodeableConceptThe category of the cost information
.... source 0..1stringThe source or owner for the price information
.... cost 1..1MoneyThe price of the medication
... monitoringProgram 0..*BackboneElementProgram under which a medication is reviewed
.... 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 program under which the medication is monitored
.... name 0..1stringName of the reviewing program
... administrationGuidelines 0..*BackboneElementGuidelines for administration of the medication
.... 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
.... dosage 0..*BackboneElementDosage for the medication for the specific guidelines
..... 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 dosage
..... dosage 1..*DosageDosage for the medication for the specific guidelines
.... indication[x] 0..1Indication for use that apply to the specific administration guidelines
..... indicationCodeableConceptCodeableConcept
..... indicationReferenceReference(ObservationDefinition)
.... patientCharacteristics 0..*BackboneElementCharacteristics of the patient that are relevant to the administration guidelines
..... 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
..... characteristic[x] 1..1Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConceptCodeableConcept
...... characteristicQuantityQuantity(SimpleQuantity)
..... value 0..*stringThe specific characteristic
... medicineClassification 0..*BackboneElementCategorization of the medication within a formulary or classification system
.... 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..1CodeableConceptThe type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..*CodeableConceptSpecific category assigned to the medication
... packaging 0..1BackboneElementDetails about packaged medications
.... 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..1CodeableConceptA code that defines the specific type of packaging that the medication can be found in
Binding: medicationKnowledge Package Type Codes (example): A coded concept defining the type of packaging of a medication.

.... quantity 0..1SimpleQuantityThe number of product units the package would contain if fully loaded
... drugCharacteristic 0..*BackboneElementSpecifies descriptive properties of the medicine
.... 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..1CodeableConceptCode specifying the type of characteristic of medication
Binding: medicationKnowledge Characteristic Codes (example): A coded concept defining the characteristic types of a medication.

.... value[x] 0..1Description of the characteristic
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueQuantityQuantity(SimpleQuantity)
..... valueBase64Binarybase64Binary
... contraindication 0..*Reference(DetectedIssue)Potential clinical issue with or between medication(s)
... regulatory 0..*BackboneElementRegulatory information about a medication
.... 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
.... regulatoryAuthority 1..1Reference(Organization)Specifies the authority of the regulation
.... substitution 0..*BackboneElementSpecifies if changes are allowed when dispensing a medication from a regulatory perspective
..... 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..1CodeableConceptSpecifies the type of substitution allowed
..... allowed 1..1booleanSpecifies if regulation allows for changes in the medication when dispensing
.... schedule 0..*BackboneElementSpecifies the schedule of a medication in jurisdiction
..... 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
..... schedule 1..1CodeableConceptSpecifies the specific drug schedule
.... maxDispense 0..1BackboneElementThe maximum number of units of the medication that can be dispensed in a period
..... 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
..... quantity 1..1SimpleQuantityThe maximum number of units of the medication that can be dispensed
..... period 0..1DurationThe period that applies to the maximum number of units
... kinetics 0..*BackboneElementThe time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... 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
.... areaUnderCurve 0..*SimpleQuantityThe drug concentration measured at certain discrete points in time
.... lethalDose50 0..*SimpleQuantityThe median lethal dose of a drug
.... halfLifePeriod 0..1DurationTime required for concentration in the body to decrease by half

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
MedicationKnowledge.languagepreferredCommonLanguages
Max Binding: AllLanguages
MedicationKnowledge.coderequiredUSCoreMedicationCodes
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
MedicationKnowledge.doseFormexampleSNOMEDCTFormCodes
MedicationKnowledge.intendedRouteexampleSNOMEDCTRouteCodes
MedicationKnowledge.packaging.typeexamplemedicationKnowledge Package Type Codes
MedicationKnowledge.drugCharacteristic.typeexamplemedicationKnowledge Characteristic Codes