DaVinci Payer Data Exchange (PDex) US Drug Formulary STU 1
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-CoveragePlan
The CoveragePlan resource represents a health plan health plan and 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 Jan 17 00:00:00 UTC 2020 as a draft by HL7 Pharmacy WG.
Summary
Mandatory: 7 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 FormularyDrug 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 constrain entry to 1..* constrain identifier to 1..*
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List | I | 0..* | List | Coverage Plan |
  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 | 4..* | Extension | Extension Slice: Unordered, Open by value:url |
 usdf-DrugTierDefinition-extension | SI | 1..* | (Complex) | DrugTierDefinition URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension |
| usdf-Network-extension | SI | 1..* | string | Network URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension |
| usdf-SummaryURL-extension | SI | 1..1 | string | SummaryURL URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension |
| usdf-FormularyURL-extension | SI | 0..1 | string | FormularyURL URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyURL-extension |
| usdf-EmailPlanContact-extension | SI | 0..1 | string | EmailPlanContact URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-EmailPlanContact-extension |
| usdf-MarketingURL-extension | SI | 0..1 | string | MarketingURL URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-MarketingURL-extension |
| usdf-PlanIDType-extension | SI | 1..1 | string | PlanIDType URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SI | 1..1 | Identifier | Business identifier |
| status | ?!SΣI | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
| mode | ?!SΣI | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
| title | ΣI | 1..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
| code | ΣI | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example) |
 subject | ΣI | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
| encounter | I | 0..1 | Reference(Encounter) | Context in which list created |
| date | ΣI | 0..1 | dateTime | When the list was prepared |
| source | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
| orderedBy | I | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred) |
| note | I | 0..* | Annotation | Comments about the list |
| entry | I | 1..* | BackboneElement | Entries in the list |
 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 |
| flag | I | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example) |
| deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | I | 0..1 | dateTime | When item added to list |
 item | I | 1..1 | Reference(Formulary Drug) | Actual entry |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred) |
| Documentation for this format | ||||
Summary
Mandatory: 7 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 FormularyDrug 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 constrain entry to 1..* constrain identifier to 1..*
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List | I | 0..* | List | Coverage Plan |
| 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 | 4..* | Extension | Extension Slice: Unordered, Open by value:url |
| usdf-DrugTierDefinition-extension | SI | 1..* | (Complex) | DrugTierDefinition URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension |
| usdf-Network-extension | SI | 1..* | string | Network URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension |
| usdf-SummaryURL-extension | SI | 1..1 | string | SummaryURL URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension |
| usdf-FormularyURL-extension | SI | 0..1 | string | FormularyURL URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyURL-extension |
| usdf-EmailPlanContact-extension | SI | 0..1 | string | EmailPlanContact URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-EmailPlanContact-extension |
| usdf-MarketingURL-extension | SI | 0..1 | string | MarketingURL URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-MarketingURL-extension |
| usdf-PlanIDType-extension | SI | 1..1 | string | PlanIDType URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SI | 1..1 | Identifier | Business identifier |
| status | ?!SΣI | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
| mode | ?!SΣI | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
| title | ΣI | 1..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
| code | ΣI | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example) |
| subject | ΣI | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
| encounter | I | 0..1 | Reference(Encounter) | Context in which list created |
| date | ΣI | 0..1 | dateTime | When the list was prepared |
| source | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
| orderedBy | I | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred) |
| note | I | 0..* | Annotation | Comments about the list |
| entry | I | 1..* | BackboneElement | Entries in the list |
| 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 |
| flag | I | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example) |
| deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
| date | I | 0..1 | dateTime | When item added to list |
| item | I | 1..1 | Reference(Formulary Drug) | Actual entry |
| emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred) |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron
| Path | Conformance | ValueSet |
| List.language | preferred | CommonLanguages Max Binding: AllLanguages |
| List.status | required | ListStatus |
| List.mode | required | ListMode |
| List.code | example | ExampleUseCodesForList |
| List.orderedBy | preferred | ListOrderCodes |
| List.entry.flag | example | PatientMedicineChangeTypes |
| List.emptyReason | preferred | ListEmptyReasons |
| Id | Path | Details | Requirements |
| dom-2 | List | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | List | 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 | List | 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 | List | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | List | A resource should have narrative for robust management : text.`div`.exists() | |
| lst-1 | List | A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| lst-2 | List | The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty() | |
| lst-3 | List | An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty() | |
| ele-1 | List.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:drugtierdefinition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension:drugtierdefinition | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:network | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension:network | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:summaryurl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension:summaryurl | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:formularyurl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension:formularyurl | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:emailplancontact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension:emailplancontact | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:marketingurl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension:marketingurl | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.extension:planidtype | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.extension:planidtype | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.title | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.orderedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | List.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | List.entry.flag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.entry.deleted | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.entry.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.entry.item | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | List.emptyReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
©2020+
HL7 Pharmacy WG.
Package hl7.fhir.us.davinci-drug-formulary#1.0.0 based on FHIR 4.0.1.
Generated 2020-01-21.
Links:
Home
| QA Report | Search
|
Version History
|
|
Propose a change
identifier