This page is part of the US Drug Formulary (v1.0.1: STU 1) based on FHIR R4. The current version which supercedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan |
Version: | 1.0.1 |
Name: | CoveragePlan |
Title: | Formulary Coverage Plan |
Status: | Active as of 2020-12-21T16:49:28+00:00 |
Definition: | 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. |
Publisher: | HL7 Pharmacy Working Group |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-CoveragePlan
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from List
Summary
Mandatory: 4 elements
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
This structure is derived from List
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | A list is a curated collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 4..* | Extension | Extension Slice: Unordered, Open by value:url | |
usdf-DrugTierDefinition-extension | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension |
usdf-Network-extension | S | 1..* | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension |
usdf-SummaryURL-extension | S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension |
usdf-FormularyURL-extension | S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyURL-extension |
usdf-EmailPlanContact-extension | S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-EmailPlanContact-extension |
usdf-MarketingURL-extension | S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-MarketingURL-extension |
usdf-PlanIDType-extension | S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Business identifier | |
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. |
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
encounter | 0..1 | Reference(Encounter) | Context in which list created | |
date | Σ | 0..1 | dateTime | When the list was prepared |
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
orderedBy | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |
note | 0..* | Annotation | Comments about the list | |
entry | I | 0..* | BackboneElement | Entries in the list |
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 |
flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |
deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
date | 0..1 | dateTime | When item added to list | |
item | 1..1 | Reference(Resource) | Actual entry | |
emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. |
Documentation for this format |
This structure is derived from List
Summary
Mandatory: 4 elements
Must-Support: 7 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from List
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | A list is a curated collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
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) Max Binding: AllLanguages: A human language. | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 4..* | Extension | Extension Slice: Unordered, Open by value:url | |
usdf-DrugTierDefinition-extension | S | 1..* | (Complex) | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugTierDefinition-extension |
usdf-Network-extension | S | 1..* | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Network-extension |
usdf-SummaryURL-extension | S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-SummaryURL-extension |
usdf-FormularyURL-extension | S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyURL-extension |
usdf-EmailPlanContact-extension | S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-EmailPlanContact-extension |
usdf-MarketingURL-extension | S | 0..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-MarketingURL-extension |
usdf-PlanIDType-extension | S | 1..1 | string | Extension URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PlanIDType-extension |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | 0..* | Identifier | Business identifier | |
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. |
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. |
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is. |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
encounter | 0..1 | Reference(Encounter) | Context in which list created | |
date | Σ | 0..1 | dateTime | When the list was prepared |
source | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) |
orderedBy | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |
note | 0..* | Annotation | Comments about the list | |
entry | I | 0..* | BackboneElement | Entries in the list |
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 |
flag | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: PatientMedicineChangeTypes (example): Codes that provide further information about the reason and meaning of the item in the list. | |
deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
date | 0..1 | dateTime | When item added to list | |
item | 1..1 | Reference(Resource) | Actual entry | |
emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. |
Documentation for this format |
Other representations of profile: 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 |