US Drug Formulary STU Ballot

This page is part of the US Drug Formulary (v0.1.0: STU 1 Draft) 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

CoveragePlan

 

The official URL for this profile is: 

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

A health plan which contains links to administrative information, a list of formulary drugs covered under that plan, and a definition of drug tiers and their associated cost-sharing models.

This profile builds on List.

This profile was published on Fri Jun 21 00:00:00 EDT 2019 as a draft by HL7 Pharmacy WG.

Summary

Mandatory: 0 element (6 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

usdf.CoveragePlan maps to List:
  PlanIdentifier maps to identifier
  CoveragePlanMode maps to mode
  CoveragePlanStatus maps to status
  MarketingName maps to title
  FormularyDrugEntry maps to entry.item
  DrugTierDefinition maps to extension
  Network maps to extension
  SummaryURL maps to extension
  FormularyURL maps to extension
  EmailPlanContact maps to extension
  MarketingURL maps to extension
  LastUpdatedOn maps to date
NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*usdf-CoveragePlan
lst-3: An entry date can only be used if the mode of the list is "working"
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-1: A list can only have an emptyReason if it is empty
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 4..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... usdf-DrugTierDefinition-extension S1..*(Complex)DrugTierDefinition
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
... usdf-Network-extension S1..*stringNetwork
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension
... usdf-SummaryURL-extension S1..1stringSummaryURL
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension
... usdf-FormularyURL-extension S0..1stringFormularyURL
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyURL-extension
... usdf-EmailPlanContact-extension S0..1stringEmailPlanContact
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-EmailPlanContact-extension
... usdf-MarketingURL-extension S0..1stringMarketingURL
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-MarketingURL-extension
... usdf-PlanIDType-extension S1..1stringPlanIDType
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness identifier
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title Σ1..1stringDescriptive name for the list
... code Σ0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject Σ0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note 0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(usdf-FormularyDrug)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

Summary

Mandatory: 0 element (6 nested mandatory elements)
Must-Support: 10 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

usdf.CoveragePlan maps to List:
  PlanIdentifier maps to identifier
  CoveragePlanMode maps to mode
  CoveragePlanStatus maps to status
  MarketingName maps to title
  FormularyDrugEntry maps to entry.item
  DrugTierDefinition maps to extension
  Network maps to extension
  SummaryURL maps to extension
  FormularyURL maps to extension
  EmailPlanContact maps to extension
  MarketingURL maps to extension
  LastUpdatedOn maps to date

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*usdf-CoveragePlan
lst-3: An entry date can only be used if the mode of the list is "working"
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-1: A list can only have an emptyReason if it is empty
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 4..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... usdf-DrugTierDefinition-extension S1..*(Complex)DrugTierDefinition
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension
... usdf-Network-extension S1..*stringNetwork
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension
... usdf-SummaryURL-extension S1..1stringSummaryURL
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension
... usdf-FormularyURL-extension S0..1stringFormularyURL
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyURL-extension
... usdf-EmailPlanContact-extension S0..1stringEmailPlanContact
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-EmailPlanContact-extension
... usdf-MarketingURL-extension S0..1stringMarketingURL
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-MarketingURL-extension
... usdf-PlanIDType-extension S1..1stringPlanIDType
URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S1..1IdentifierBusiness identifier
... status ?!SΣ1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!SΣ1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title Σ1..1stringDescriptive name for the list
... code Σ0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject Σ0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter 0..1Reference(Encounter)Context in which list created
... date Σ0..1dateTimeWhen the list was prepared
... source Σ0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy 0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note 0..*AnnotationComments about the list
... entry I0..*BackboneElementEntries in the list
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag 0..1CodeableConceptStatus/Workflow information about this item
Binding: PatientMedicineChangeTypes (example)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date 0..1dateTimeWhen item added to list
.... item 1..1Reference(usdf-FormularyDrug)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathConformanceValueSet
List:usdf-CoveragePlan.languagepreferredCommonLanguages
Max Binding: AllLanguages
List:usdf-CoveragePlan.statusrequiredListStatus
List:usdf-CoveragePlan.moderequiredListMode
List:usdf-CoveragePlan.codeexampleExampleUseCodesForList
List:usdf-CoveragePlan.orderedBypreferredListOrderCodes
List:usdf-CoveragePlan.entry.flagexamplePatientMedicineChangeTypes
List:usdf-CoveragePlan.emptyReasonpreferredListEmptyReasons

 

Constraints

IdPathDetailsRequirements
dom-2ListIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4ListIf 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-3ListIf 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-6ListA resource should have narrative for robust management
: text.div.exists()
dom-5ListIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
lst-3ListAn entry date can only be used if the mode of the list is "working"
: mode = 'working' or entry.date.empty()
lst-2ListThe deleted flag can only be used if the mode of the list is "changes"
: mode = 'changes' or entry.deleted.empty()
lst-1ListA list can only have an emptyReason if it is empty
: emptyReason.empty() or entry.empty()
ele-1List.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())