This page is part of the US Drug Formulary (v1.0.0: 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
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
The FormularyDrug resource represents a drug that is part of a drug formulary. A drug formulary is a list of brand-name and generic prescription drugs a health insurer agrees to pay for, at least partially, as part of health insurance coverage.In addition to identifying the drug by its RxNorm code, and the PlanID of the formulary, the FormularyDrug entry provides information on prescribing limitations, and optionally drug classification and alternatives.
This profile builds on MedicationKnowledge.
This profile was published on Fri Jan 17 00:00:00 UTC 2020 as a draft by HL7 Pharmacy WG.
Summary
Mandatory: 3 elements
Must-Support: 5 elements
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
usdf.FormularyDrug maps to MedicationKnowledge: DrugCode maps to code DrugClass maps to medicineClassification.classification DrugAlternatives maps to extension PriorAuthorization maps to extension StepTherapyLimit maps to extension QuantityLimit maps to extension PlanID maps to extension DrugTierID maps to extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | I | 0..* | MedicationKnowledge | Formulary Drug |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 2..* | Extension | Extension Slice: Unordered, Open by value:url |
usdf-DrugAlternatives-extension | I | 0..* | Reference() | DrugAlternatives URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugAlternatives-extension |
usdf-PriorAuthorization-extension | SI | 0..1 | boolean | PriorAuthorization URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension |
usdf-StepTherapyLimit-extension | SI | 0..1 | boolean | StepTherapyLimit URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension |
usdf-QuantityLimit-extension | SI | 0..1 | boolean | QuantityLimit URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension |
usdf-PlanID-extension | SI | 1..1 | string | PlanID URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension |
usdf-DrugTierID-extension | SI | 1..1 | CodeableConcept | DrugTierID URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
code | ΣI | 1..1 | CodeableConcept | Code that identifies this medication Binding: US Core Medication Codes (RxNorm) (extensible) |
status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: MedicationKnowledge Status Codes (required) |
manufacturer | ΣI | 0..1 | Reference(Organization) | Manufacturer of the item |
doseForm | I | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example) |
amount | ΣI | 0..1 | SimpleQuantity | Amount of drug in package |
synonym | ΣI | 0..* | string | Additional names for a medication |
relatedMedicationKnowledge | I | 0..* | BackboneElement | Associated or related medication information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Category of medicationKnowledge |
reference | I | 1..* | Reference(MedicationKnowledge) | Associated documentation about the associated medication knowledge |
associatedMedication | I | 0..* | Reference(Medication) | A medication resource that is associated with this medication |
productType | I | 0..* | CodeableConcept | Category of the medication or product |
monograph | I | 0..* | BackboneElement | Associated documentation about the medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | The category of medication document |
source | I | 0..1 | Reference(DocumentReference | Media) | Associated documentation about the medication |
ingredient | I | 0..* | BackboneElement | Active or inactive ingredient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item[x] | I | 1..1 | Medication(s) or substance(s) contained in the medication | |
itemCodeableConcept | CodeableConcept | |||
itemReference | Reference(Substance) | |||
isActive | I | 0..1 | boolean | Active ingredient indicator |
strength | I | 0..1 | Ratio | Quantity of ingredient present |
preparationInstruction | I | 0..1 | markdown | The instructions for preparing the medication |
intendedRoute | I | 0..* | CodeableConcept | The intended or approved route of administration Binding: SNOMEDCTRouteCodes (example) |
cost | I | 0..* | BackboneElement | The pricing of the medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | The category of the cost information |
source | I | 0..1 | string | The source or owner for the price information |
cost | I | 1..1 | Money | The price of the medication |
monitoringProgram | I | 0..* | BackboneElement | Program under which a medication is reviewed |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | Type of program under which the medication is monitored |
name | I | 0..1 | string | Name of the reviewing program |
administrationGuidelines | I | 0..* | BackboneElement | Guidelines for administration of the medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dosage | I | 0..* | BackboneElement | Dosage for the medication for the specific guidelines |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Type of dosage |
dosage | I | 1..* | Dosage | Dosage for the medication for the specific guidelines |
indication[x] | I | 0..1 | Indication for use that apply to the specific administration guidelines | |
indicationCodeableConcept | CodeableConcept | |||
indicationReference | Reference(ObservationDefinition) | |||
patientCharacteristics | I | 0..* | BackboneElement | Characteristics of the patient that are relevant to the administration guidelines |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
characteristic[x] | I | 1..1 | Specific characteristic that is relevant to the administration guideline | |
characteristicCodeableConcept | CodeableConcept | |||
characteristicQuantity | Quantity(SimpleQuantity) | |||
value | I | 0..* | string | The specific characteristic |
medicineClassification | I | 0..* | BackboneElement | Categorization of the medication within a formulary or classification system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) |
classification | I | 0..* | CodeableConcept | Specific category assigned to the medication |
packaging | I | 0..1 | BackboneElement | Details about packaged medications |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 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) |
quantity | I | 0..1 | SimpleQuantity | The number of product units the package would contain if fully loaded |
drugCharacteristic | I | 0..* | BackboneElement | Specifies descriptive properties of the medicine |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | Code specifying the type of characteristic of medication Binding: medicationKnowledge Characteristic Codes (example) |
value[x] | I | 0..1 | Description of the characteristic | |
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | Quantity(SimpleQuantity) | |||
valueBase64Binary | base64Binary | |||
contraindication | I | 0..* | Reference(DetectedIssue) | Potential clinical issue with or between medication(s) |
regulatory | I | 0..* | BackboneElement | Regulatory information about a medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
regulatoryAuthority | I | 1..1 | Reference(Organization) | Specifies the authority of the regulation |
substitution | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Specifies the type of substitution allowed |
allowed | I | 1..1 | boolean | Specifies if regulation allows for changes in the medication when dispensing |
schedule | I | 0..* | BackboneElement | Specifies the schedule of a medication in jurisdiction |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
schedule | I | 1..1 | CodeableConcept | Specifies the specific drug schedule |
maxDispense | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
quantity | I | 1..1 | SimpleQuantity | The maximum number of units of the medication that can be dispensed |
period | I | 0..1 | Duration | The period that applies to the maximum number of units |
kinetics | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
areaUnderCurve | I | 0..* | SimpleQuantity | The drug concentration measured at certain discrete points in time |
lethalDose50 | I | 0..* | SimpleQuantity | The median lethal dose of a drug |
halfLifePeriod | I | 0..1 | Duration | Time required for concentration in the body to decrease by half |
Documentation for this format |
Summary
Mandatory: 3 elements
Must-Support: 5 elements
Extensions
This structure refers to these extensions:
Mapping Source
This structure represents the following mapping definition:
usdf.FormularyDrug maps to MedicationKnowledge: DrugCode maps to code DrugClass maps to medicineClassification.classification DrugAlternatives maps to extension PriorAuthorization maps to extension StepTherapyLimit maps to extension QuantityLimit maps to extension PlanID maps to extension DrugTierID maps to extension
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MedicationKnowledge | I | 0..* | MedicationKnowledge | Formulary Drug |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 2..* | Extension | Extension Slice: Unordered, Open by value:url |
usdf-DrugAlternatives-extension | I | 0..* | Reference() | DrugAlternatives URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugAlternatives-extension |
usdf-PriorAuthorization-extension | SI | 0..1 | boolean | PriorAuthorization URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PriorAuthorization-extension |
usdf-StepTherapyLimit-extension | SI | 0..1 | boolean | StepTherapyLimit URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-StepTherapyLimit-extension |
usdf-QuantityLimit-extension | SI | 0..1 | boolean | QuantityLimit URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-QuantityLimit-extension |
usdf-PlanID-extension | SI | 1..1 | string | PlanID URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanID-extension |
usdf-DrugTierID-extension | SI | 1..1 | CodeableConcept | DrugTierID URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierID-extension |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
code | ΣI | 1..1 | CodeableConcept | Code that identifies this medication Binding: US Core Medication Codes (RxNorm) (extensible) |
status | ?!ΣI | 0..1 | code | active | inactive | entered-in-error Binding: MedicationKnowledge Status Codes (required) |
manufacturer | ΣI | 0..1 | Reference(Organization) | Manufacturer of the item |
doseForm | I | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: SNOMEDCTFormCodes (example) |
amount | ΣI | 0..1 | SimpleQuantity | Amount of drug in package |
synonym | ΣI | 0..* | string | Additional names for a medication |
relatedMedicationKnowledge | I | 0..* | BackboneElement | Associated or related medication information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Category of medicationKnowledge |
reference | I | 1..* | Reference(MedicationKnowledge) | Associated documentation about the associated medication knowledge |
associatedMedication | I | 0..* | Reference(Medication) | A medication resource that is associated with this medication |
productType | I | 0..* | CodeableConcept | Category of the medication or product |
monograph | I | 0..* | BackboneElement | Associated documentation about the medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | The category of medication document |
source | I | 0..1 | Reference(DocumentReference | Media) | Associated documentation about the medication |
ingredient | I | 0..* | BackboneElement | Active or inactive ingredient |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
item[x] | I | 1..1 | Medication(s) or substance(s) contained in the medication | |
itemCodeableConcept | CodeableConcept | |||
itemReference | Reference(Substance) | |||
isActive | I | 0..1 | boolean | Active ingredient indicator |
strength | I | 0..1 | Ratio | Quantity of ingredient present |
preparationInstruction | I | 0..1 | markdown | The instructions for preparing the medication |
intendedRoute | I | 0..* | CodeableConcept | The intended or approved route of administration Binding: SNOMEDCTRouteCodes (example) |
cost | I | 0..* | BackboneElement | The pricing of the medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | The category of the cost information |
source | I | 0..1 | string | The source or owner for the price information |
cost | I | 1..1 | Money | The price of the medication |
monitoringProgram | I | 0..* | BackboneElement | Program under which a medication is reviewed |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | Type of program under which the medication is monitored |
name | I | 0..1 | string | Name of the reviewing program |
administrationGuidelines | I | 0..* | BackboneElement | Guidelines for administration of the medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
dosage | I | 0..* | BackboneElement | Dosage for the medication for the specific guidelines |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Type of dosage |
dosage | I | 1..* | Dosage | Dosage for the medication for the specific guidelines |
indication[x] | I | 0..1 | Indication for use that apply to the specific administration guidelines | |
indicationCodeableConcept | CodeableConcept | |||
indicationReference | Reference(ObservationDefinition) | |||
patientCharacteristics | I | 0..* | BackboneElement | Characteristics of the patient that are relevant to the administration guidelines |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
characteristic[x] | I | 1..1 | Specific characteristic that is relevant to the administration guideline | |
characteristicCodeableConcept | CodeableConcept | |||
characteristicQuantity | Quantity(SimpleQuantity) | |||
value | I | 0..* | string | The specific characteristic |
medicineClassification | I | 0..* | BackboneElement | Categorization of the medication within a formulary or classification system |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification) |
classification | I | 0..* | CodeableConcept | Specific category assigned to the medication |
packaging | I | 0..1 | BackboneElement | Details about packaged medications |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 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) |
quantity | I | 0..1 | SimpleQuantity | The number of product units the package would contain if fully loaded |
drugCharacteristic | I | 0..* | BackboneElement | Specifies descriptive properties of the medicine |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 0..1 | CodeableConcept | Code specifying the type of characteristic of medication Binding: medicationKnowledge Characteristic Codes (example) |
value[x] | I | 0..1 | Description of the characteristic | |
valueCodeableConcept | CodeableConcept | |||
valueString | string | |||
valueQuantity | Quantity(SimpleQuantity) | |||
valueBase64Binary | base64Binary | |||
contraindication | I | 0..* | Reference(DetectedIssue) | Potential clinical issue with or between medication(s) |
regulatory | I | 0..* | BackboneElement | Regulatory information about a medication |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
regulatoryAuthority | I | 1..1 | Reference(Organization) | Specifies the authority of the regulation |
substitution | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | I | 1..1 | CodeableConcept | Specifies the type of substitution allowed |
allowed | I | 1..1 | boolean | Specifies if regulation allows for changes in the medication when dispensing |
schedule | I | 0..* | BackboneElement | Specifies the schedule of a medication in jurisdiction |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
schedule | I | 1..1 | CodeableConcept | Specifies the specific drug schedule |
maxDispense | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
quantity | I | 1..1 | SimpleQuantity | The maximum number of units of the medication that can be dispensed |
period | I | 0..1 | Duration | The period that applies to the maximum number of units |
kinetics | I | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
areaUnderCurve | I | 0..* | SimpleQuantity | The drug concentration measured at certain discrete points in time |
lethalDose50 | I | 0..* | SimpleQuantity | The median lethal dose of a drug |
halfLifePeriod | I | 0..1 | Duration | Time required for concentration in the body to decrease by half |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
Path | Conformance | ValueSet |
MedicationKnowledge.language | preferred | CommonLanguages Max Binding: AllLanguages |
MedicationKnowledge.code | extensible | USCoreMedicationCodes |
MedicationKnowledge.status | required | MedicationKnowledge Status Codes |
MedicationKnowledge.doseForm | example | SNOMEDCTFormCodes |
MedicationKnowledge.intendedRoute | example | SNOMEDCTRouteCodes |
MedicationKnowledge.packaging.type | example | medicationKnowledge Package Type Codes |
MedicationKnowledge.drugCharacteristic.type | example | medicationKnowledge Characteristic Codes |
Id | Path | Details | Requirements |
dom-2 | MedicationKnowledge | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | MedicationKnowledge | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | MedicationKnowledge | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | MedicationKnowledge | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | MedicationKnowledge | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | MedicationKnowledge.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.extension:drugalternatives | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.extension:drugalternatives | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.extension:priorauthorization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.extension:priorauthorization | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.extension:steptherapylimit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.extension:steptherapylimit | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.extension:quantitylimit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.extension:quantitylimit | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.extension:planid | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.extension:planid | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.extension:drugtierid | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.extension:drugtierid | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.manufacturer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.doseForm | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.amount | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.synonym | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.relatedMedicationKnowledge | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.relatedMedicationKnowledge.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.relatedMedicationKnowledge.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.relatedMedicationKnowledge.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.relatedMedicationKnowledge.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.relatedMedicationKnowledge.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.relatedMedicationKnowledge.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.associatedMedication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.productType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.monograph | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.monograph.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.monograph.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.monograph.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.monograph.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.monograph.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.monograph.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.ingredient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.ingredient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.ingredient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.ingredient.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.ingredient.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.ingredient.item[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.ingredient.isActive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.ingredient.strength | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.preparationInstruction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.intendedRoute | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.cost | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.cost.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.cost.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.cost.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.cost.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.cost.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.cost.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.cost.cost | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.monitoringProgram | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.monitoringProgram.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.monitoringProgram.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.monitoringProgram.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.monitoringProgram.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.monitoringProgram.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.monitoringProgram.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.administrationGuidelines.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.administrationGuidelines.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.administrationGuidelines.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.administrationGuidelines.dosage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines.dosage.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.administrationGuidelines.dosage.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.administrationGuidelines.dosage.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.administrationGuidelines.dosage.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.administrationGuidelines.dosage.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines.dosage.dosage | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines.indication[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines.patientCharacteristics | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines.patientCharacteristics.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.administrationGuidelines.patientCharacteristics.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.administrationGuidelines.patientCharacteristics.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.administrationGuidelines.patientCharacteristics.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.administrationGuidelines.patientCharacteristics.characteristic[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.administrationGuidelines.patientCharacteristics.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.medicineClassification | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.medicineClassification.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.medicineClassification.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.medicineClassification.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.medicineClassification.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.medicineClassification.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.medicineClassification.classification | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.packaging | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.packaging.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.packaging.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.packaging.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.packaging.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.packaging.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.packaging.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.drugCharacteristic | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.drugCharacteristic.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.drugCharacteristic.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.drugCharacteristic.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.drugCharacteristic.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.drugCharacteristic.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.drugCharacteristic.value[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.contraindication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.regulatoryAuthority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.substitution | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.substitution.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.substitution.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.substitution.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.substitution.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.substitution.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.substitution.allowed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.schedule | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.schedule.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.schedule.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.schedule.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.schedule.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.schedule.schedule | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.maxDispense | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.maxDispense.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.maxDispense.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.maxDispense.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.regulatory.maxDispense.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.regulatory.maxDispense.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.regulatory.maxDispense.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.kinetics | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.kinetics.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.kinetics.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.kinetics.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MedicationKnowledge.kinetics.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MedicationKnowledge.kinetics.areaUnderCurve | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.kinetics.lethalDose50 | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MedicationKnowledge.kinetics.halfLifePeriod | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |