DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.1.0 - STU2.1 United States of America flag

This page is part of the US Drug Formulary (v2.1.0: STU2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: Formulary Drug

Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug Version: 2.1.0
Standards status: Trial-use Computable Name: FormularyDrug
Other Identifiers: OID:2.25.74595174031514506193398850787025340071.42.8

Drug information which may be part of a formulary including its RxNorm code and dose form.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge C 0..* MedicationKnowledge Definition of Medication Knowledge
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
scd-sbd-requires-scdg-sbdg: All drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated SΣ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
..... coding:semantic-drug SΣ 1..* Coding Semantic clinical or brand drug or pack including strength
Binding: Semantic Drug Codes (required)
ele-1: All FHIR elements must have a @value or children
...... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
...... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... coding:semantic-drug-form-group SΣ 0..* Coding Semantic clinical or brand drug without strength
Binding: Semantic Drug Form Group Codes (required)
ele-1: All FHIR elements must have a @value or children
...... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
...... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code active | inactive | entered-in-error
Binding: MedicationKnowledge Status Codes (required): A coded concept defining if the medication is in active use.


ele-1: All FHIR elements must have a @value or children
... doseForm S 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.code.coding:semantic-drugrequiredSemanticDrugVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugVS
from this IG
MedicationKnowledge.code.coding:semantic-drug-form-grouprequiredSemanticDrugFormGroupVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS
from this IG
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard
MedicationKnowledge.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
scd-sbd-requires-scdg-sbdgerrorMedicationKnowledgeAll drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
: code.where(coding[0].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/NonPackSemanticDrugVS')).exists() implies code.where(coding[1].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS')).exists()

This structure is derived from MedicationKnowledge

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge C 0..* MedicationKnowledge Definition of Medication Knowledge
scd-sbd-requires-scdg-sbdg: All drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
... meta
.... lastUpdated S 1..1 instant When the resource version last changed
... code S 1..1 CodeableConcept Code that identifies this medication
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:semantic-drug S 1..* Coding Semantic clinical or brand drug or pack including strength
Binding: Semantic Drug Codes (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
..... coding:semantic-drug-form-group S 0..* Coding Semantic clinical or brand drug without strength
Binding: Semantic Drug Form Group Codes (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
... status S 1..1 code active | inactive | entered-in-error

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationKnowledge.code.coding:semantic-drugrequiredSemanticDrugVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugVS
from this IG
MedicationKnowledge.code.coding:semantic-drug-form-grouprequiredSemanticDrugFormGroupVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
scd-sbd-requires-scdg-sbdgerrorMedicationKnowledgeAll drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
: code.where(coding[0].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/NonPackSemanticDrugVS')).exists() implies code.where(coding[1].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS')).exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge C 0..* MedicationKnowledge Definition of Medication Knowledge
scd-sbd-requires-scdg-sbdg: All drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Code that identifies this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:semantic-drug SΣ 1..* Coding Semantic clinical or brand drug or pack including strength
Binding: Semantic Drug Codes (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:semantic-drug-form-group SΣ 0..* Coding Semantic clinical or brand drug without strength
Binding: Semantic Drug Form Group Codes (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... status ?!SΣ 1..1 code active | inactive | entered-in-error
Binding: MedicationKnowledge Status Codes (required): A coded concept defining if the medication is in active use.

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

... amount Σ 0..1 SimpleQuantity Amount of drug in package
... synonym Σ 0..* string Additional names for a medication
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category 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..* CodeableConcept Category of the medication or product
... monograph 0..* BackboneElement Associated documentation about the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference | Media) Associated documentation about the medication
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 Medication(s) or substance(s) contained in the medication
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example): A coded concept defining the intended route of administration.


... cost 0..* BackboneElement The pricing of the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost 1..1 Money The price of the medication
... monitoringProgram 0..* BackboneElement Program under which a medication is reviewed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... administrationGuidelines 0..* BackboneElement Guidelines for administration of the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Type of dosage
..... dosage 1..* Dosage Dosage for the medication for the specific guidelines
.... indication[x] 0..1 Indication for use that apply to the specific administration guidelines
..... indicationCodeableConcept CodeableConcept
..... indicationReference Reference(ObservationDefinition)
.... patientCharacteristics 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristic[x] 1..1 Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConcept CodeableConcept
...... characteristicQuantity Quantity(SimpleQuantity)
..... value 0..* string The specific characteristic
... medicineClassification 0..* BackboneElement Categorization of the medication within a formulary or classification system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..* CodeableConcept Specific category assigned to the medication
... packaging 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept A 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..1 SimpleQuantity The number of product units the package would contain if fully loaded
... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Code 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..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
... contraindication 0..* Reference(DetectedIssue) Potential clinical issue with or between medication(s)
... regulatory 0..* BackboneElement Regulatory information about a medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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..* BackboneElement Specifies the schedule of a medication in jurisdiction
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... schedule 1..1 CodeableConcept Specifies the specific drug schedule
.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
... kinetics 0..* BackboneElement The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... areaUnderCurve 0..* SimpleQuantity The drug concentration measured at certain discrete points in time
.... lethalDose50 0..* SimpleQuantity The median lethal dose of a drug
.... halfLifePeriod 0..1 Duration Time required for concentration in the body to decrease by half

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationKnowledge.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationKnowledge.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.code.coding:semantic-drugrequiredSemanticDrugVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugVS
from this IG
MedicationKnowledge.code.coding:semantic-drug-form-grouprequiredSemanticDrugFormGroupVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS
from this IG
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard
MedicationKnowledge.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
MedicationKnowledge.intendedRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationKnowledge.packaging.typeexamplemedicationKnowledge Package Type Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-package-type
from the FHIR Standard
MedicationKnowledge.drugCharacteristic.typeexamplemedicationKnowledge Characteristic Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-characteristic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
scd-sbd-requires-scdg-sbdgerrorMedicationKnowledgeAll drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
: code.where(coding[0].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/NonPackSemanticDrugVS')).exists() implies code.where(coding[1].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS')).exists()

This structure is derived from MedicationKnowledge

Summary

Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 11 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationKnowledge.code.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge C 0..* MedicationKnowledge Definition of Medication Knowledge
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
scd-sbd-requires-scdg-sbdg: All drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated SΣ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
..... coding:semantic-drug SΣ 1..* Coding Semantic clinical or brand drug or pack including strength
Binding: Semantic Drug Codes (required)
ele-1: All FHIR elements must have a @value or children
...... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
...... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
..... coding:semantic-drug-form-group SΣ 0..* Coding Semantic clinical or brand drug without strength
Binding: Semantic Drug Form Group Codes (required)
ele-1: All FHIR elements must have a @value or children
...... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
...... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code active | inactive | entered-in-error
Binding: MedicationKnowledge Status Codes (required): A coded concept defining if the medication is in active use.


ele-1: All FHIR elements must have a @value or children
... doseForm S 0..1 CodeableConcept powder | tablets | capsule +
Binding: SNOMEDCTFormCodes (example): A coded concept defining the form of a medication.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.code.coding:semantic-drugrequiredSemanticDrugVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugVS
from this IG
MedicationKnowledge.code.coding:semantic-drug-form-grouprequiredSemanticDrugFormGroupVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS
from this IG
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard
MedicationKnowledge.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
scd-sbd-requires-scdg-sbdgerrorMedicationKnowledgeAll drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
: code.where(coding[0].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/NonPackSemanticDrugVS')).exists() implies code.where(coding[1].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS')).exists()

Differential View

This structure is derived from MedicationKnowledge

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge C 0..* MedicationKnowledge Definition of Medication Knowledge
scd-sbd-requires-scdg-sbdg: All drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
... meta
.... lastUpdated S 1..1 instant When the resource version last changed
... code S 1..1 CodeableConcept Code that identifies this medication
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:semantic-drug S 1..* Coding Semantic clinical or brand drug or pack including strength
Binding: Semantic Drug Codes (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
..... coding:semantic-drug-form-group S 0..* Coding Semantic clinical or brand drug without strength
Binding: Semantic Drug Form Group Codes (required)
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
... status S 1..1 code active | inactive | entered-in-error

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MedicationKnowledge.code.coding:semantic-drugrequiredSemanticDrugVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugVS
from this IG
MedicationKnowledge.code.coding:semantic-drug-form-grouprequiredSemanticDrugFormGroupVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
scd-sbd-requires-scdg-sbdgerrorMedicationKnowledgeAll drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
: code.where(coding[0].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/NonPackSemanticDrugVS')).exists() implies code.where(coding[1].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS')).exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationKnowledge C 0..* MedicationKnowledge Definition of Medication Knowledge
scd-sbd-requires-scdg-sbdg: All drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated SΣ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ 0..* Coding Tags 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..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Code that identifies this medication
Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.

.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:semantic-drug SΣ 1..* Coding Semantic clinical or brand drug or pack including strength
Binding: Semantic Drug Codes (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:semantic-drug-form-group SΣ 0..* Coding Semantic clinical or brand drug without strength
Binding: Semantic Drug Form Group Codes (required)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... status ?!SΣ 1..1 code active | inactive | entered-in-error
Binding: MedicationKnowledge Status Codes (required): A coded concept defining if the medication is in active use.

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

... amount Σ 0..1 SimpleQuantity Amount of drug in package
... synonym Σ 0..* string Additional names for a medication
... relatedMedicationKnowledge 0..* BackboneElement Associated or related medication information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept Category 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..* CodeableConcept Category of the medication or product
... monograph 0..* BackboneElement Associated documentation about the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept The category of medication document
.... source 0..1 Reference(DocumentReference | Media) Associated documentation about the medication
... ingredient 0..* BackboneElement Active or inactive ingredient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... item[x] 1..1 Medication(s) or substance(s) contained in the medication
..... itemCodeableConcept CodeableConcept
..... itemReference Reference(Substance)
.... isActive 0..1 boolean Active ingredient indicator
.... strength 0..1 Ratio Quantity of ingredient present
... preparationInstruction 0..1 markdown The instructions for preparing the medication
... intendedRoute 0..* CodeableConcept The intended or approved route of administration
Binding: SNOMEDCTRouteCodes (example): A coded concept defining the intended route of administration.


... cost 0..* BackboneElement The pricing of the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept The category of the cost information
.... source 0..1 string The source or owner for the price information
.... cost 1..1 Money The price of the medication
... monitoringProgram 0..* BackboneElement Program under which a medication is reviewed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Type of program under which the medication is monitored
.... name 0..1 string Name of the reviewing program
... administrationGuidelines 0..* BackboneElement Guidelines for administration of the medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... dosage 0..* BackboneElement Dosage for the medication for the specific guidelines
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Type of dosage
..... dosage 1..* Dosage Dosage for the medication for the specific guidelines
.... indication[x] 0..1 Indication for use that apply to the specific administration guidelines
..... indicationCodeableConcept CodeableConcept
..... indicationReference Reference(ObservationDefinition)
.... patientCharacteristics 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... characteristic[x] 1..1 Specific characteristic that is relevant to the administration guideline
...... characteristicCodeableConcept CodeableConcept
...... characteristicQuantity Quantity(SimpleQuantity)
..... value 0..* string The specific characteristic
... medicineClassification 0..* BackboneElement Categorization of the medication within a formulary or classification system
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 1..1 CodeableConcept The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)
.... classification 0..* CodeableConcept Specific category assigned to the medication
... packaging 0..1 BackboneElement Details about packaged medications
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept A 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..1 SimpleQuantity The number of product units the package would contain if fully loaded
... drugCharacteristic 0..* BackboneElement Specifies descriptive properties of the medicine
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type 0..1 CodeableConcept Code 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..1 Description of the characteristic
..... valueCodeableConcept CodeableConcept
..... valueString string
..... valueQuantity Quantity(SimpleQuantity)
..... valueBase64Binary base64Binary
... contraindication 0..* Reference(DetectedIssue) Potential clinical issue with or between medication(s)
... regulatory 0..* BackboneElement Regulatory information about a medication
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... regulatoryAuthority 1..1 Reference(Organization) Specifies the authority of the regulation
.... substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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..* BackboneElement Specifies the schedule of a medication in jurisdiction
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... schedule 1..1 CodeableConcept Specifies the specific drug schedule
.... maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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
... kinetics 0..* BackboneElement The time course of drug absorption, distribution, metabolism and excretion of a medication from the body
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... areaUnderCurve 0..* SimpleQuantity The drug concentration measured at certain discrete points in time
.... lethalDose50 0..* SimpleQuantity The median lethal dose of a drug
.... halfLifePeriod 0..1 Duration Time required for concentration in the body to decrease by half

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
MedicationKnowledge.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
MedicationKnowledge.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
MedicationKnowledge.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MedicationKnowledge.codeexampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard
MedicationKnowledge.code.coding:semantic-drugrequiredSemanticDrugVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugVS
from this IG
MedicationKnowledge.code.coding:semantic-drug-form-grouprequiredSemanticDrugFormGroupVS
http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS
from this IG
MedicationKnowledge.statusrequiredMedicationKnowledge Status Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-status|4.0.1
from the FHIR Standard
MedicationKnowledge.doseFormexampleSNOMEDCTFormCodes
http://hl7.org/fhir/ValueSet/medication-form-codes
from the FHIR Standard
MedicationKnowledge.intendedRouteexampleSNOMEDCTRouteCodes
http://hl7.org/fhir/ValueSet/route-codes
from the FHIR Standard
MedicationKnowledge.packaging.typeexamplemedicationKnowledge Package Type Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-package-type
from the FHIR Standard
MedicationKnowledge.drugCharacteristic.typeexamplemedicationKnowledge Characteristic Codes
http://hl7.org/fhir/ValueSet/medicationknowledge-characteristic
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
scd-sbd-requires-scdg-sbdgerrorMedicationKnowledgeAll drugs with RxNorm Term Type of Semantic Clinical Drug (SCD) or Semantic Branded Drug (SBD) SHALL have a coding repetition and RxNorm Term Type of Semantic Clinical Drug Group (SCDG) or Semantic Branded Drug Group (SBDG) respectively
: code.where(coding[0].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/NonPackSemanticDrugVS')).exists() implies code.where(coding[1].memberOf('http://hl7.org/fhir/us/davinci-drug-formulary/ValueSet/SemanticDrugFormGroupVS')).exists()

This structure is derived from MedicationKnowledge

Summary

Mandatory: 6 elements(3 nested mandatory elements)
Must-Support: 11 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of MedicationKnowledge.code.coding

 

Other representations of profile: CSV, Excel, Schematron