DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.0.1 - STU 2 United States of America flag

DaVinci Payer Data Exchange (PDex) US Drug Formulary, published by HL7 International / Pharmacy. This guide is not an authorized publication; it is the continuous build for version 2.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pdex-formulary/ and changes regularly. See the Directory of published versions

Resource Profile: FormularyItem - Detailed Descriptions

Page standards status: Trial-use

Definitions for the usdf-FormularyItem resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Basic
2. Basic.meta
4. Basic.meta.lastUpdated
Control1..?
Must Supporttrue
6. Basic.extension
Control4..?
SlicingThis element introduces a set of slices on Basic.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
8. Basic.extension:usdf-FormularyReference-extension
Slice Nameusdf-FormularyReference-extension
Control1..1
TypeExtension(Formulary Reference) (Extension Type: Reference(Formulary))
Must Supporttrue
10. Basic.extension:usdf-AvailabilityStatus-extension
Slice Nameusdf-AvailabilityStatus-extension
Control1..1
TypeExtension(Availability Status) (Extension Type: code)
Must Supporttrue
12. Basic.extension:usdf-AvailabilityPeriod-extension
Slice Nameusdf-AvailabilityPeriod-extension
Control0..1
TypeExtension(Availability Period) (Extension Type: Period)
Must Supporttrue
14. Basic.extension:usdf-PharmacyBenefitType-extension
Slice Nameusdf-PharmacyBenefitType-extension
Control1..*
TypeExtension(Pharmacy Benefit Type) (Extension Type: CodeableConcept)
Must Supporttrue
16. Basic.extension:usdf-DrugTierID-extension
Slice Nameusdf-DrugTierID-extension
Control1..1
TypeExtension(Drug Tier ID) (Extension Type: CodeableConcept)
Must Supporttrue
18. Basic.extension:usdf-PriorAuthorization-extension
Slice Nameusdf-PriorAuthorization-extension
Control0..1
TypeExtension(Prior Authorization) (Extension Type: boolean)
Must Supporttrue
20. Basic.extension:usdf-PriorAuthorizationNewStartsOnly-extension
Slice Nameusdf-PriorAuthorizationNewStartsOnly-extension
Control0..1
TypeExtension(Prior Authorization New Starts Only) (Extension Type: boolean)
22. Basic.extension:usdf-StepTherapyLimit-extension
Slice Nameusdf-StepTherapyLimit-extension
Control0..1
TypeExtension(Step Therapy Limit) (Extension Type: boolean)
Must Supporttrue
24. Basic.extension:usdf-StepTherapyLimitNewStartsOnly-extension
Slice Nameusdf-StepTherapyLimitNewStartsOnly-extension
Control0..1
TypeExtension(Step Therapy Limit New Starts Only) (Extension Type: boolean)
26. Basic.extension:usdf-QuantityLimit-extension
Slice Nameusdf-QuantityLimit-extension
Control0..1
TypeExtension(Quantity Limit) (Extension Type: boolean)
Must Supporttrue
28. Basic.extension:usdf-QuantityLimitDetail-extension
Slice Nameusdf-QuantityLimitDetail-extension
Control0..1
TypeExtension(Quantity Limit Detail) (Complex Extension)
30. Basic.extension:usdf-AdditionalCoverageInformation-extension
Slice Nameusdf-AdditionalCoverageInformation-extension
Control0..1
TypeExtension(Additional Coverage Information) (Extension Type: markdown)
32. Basic.code
Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-InsuranceItemTypeCS&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;formulary-item&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
34. Basic.subject
Control1..?
TypeReference(Formulary Drug)
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here

0. Basic
Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

ShortResource for non-supported content
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesZ-resource, Extension-resource, Custom-resource
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Basic.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Basic.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

ShortWhen the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control10..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Basic.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. Basic.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortExtensionAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control40..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Basic.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. Basic.extension:usdf-FormularyReference-extension
Slice Nameusdf-FormularyReference-extension
Definition

Reference to the formulary this item belongs to.

ShortFormulary Reference
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Formulary Reference) (Extension Type: Reference(Formulary))
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Basic.extension:usdf-AvailabilityStatus-extension
Slice Nameusdf-AvailabilityStatus-extension
Definition

A boolean indicating whether the formulary item is currently available under the formulary. Drugs may appear on a formulary, but not considered "active" for the current year. Drugs may also be removed during the course of a plan year.

ShortAvailability Status
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Availability Status) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Basic.extension:usdf-AvailabilityPeriod-extension
Slice Nameusdf-AvailabilityPeriod-extension
Definition

The period for which this item is available on the formulary. Drugs may appear on a formulary, but not considered "active" for the current year.

ShortAvailability Period
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Availability Period) (Extension Type: Period)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Basic.extension:usdf-PharmacyBenefitType-extension
Slice Nameusdf-PharmacyBenefitType-extension
Definition

A CodeableConcept indicating the pharmacy benefit type the formulary drug is available through the associated plan. This pharmacy benefit type is specific to the FormularyDrug and indicates which of the pharmacy benefit type from the plan applies to the particular formulary drug.

ShortPharmacy Benefit Type
Control1..*
This element is affected by the following invariants: ele-1
TypeExtension(Pharmacy Benefit Type) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Basic.extension:usdf-DrugTierID-extension
Slice Nameusdf-DrugTierID-extension
Definition

A code that describes the coverage status of a drug in a health plan (e.g., preferred generic, specialty, etc.)

ShortDrug Tier ID
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Drug Tier ID) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Basic.extension:usdf-PriorAuthorization-extension
Slice Nameusdf-PriorAuthorization-extension
Definition

A Boolean indication of whether the coverage plan imposes a prior authorization requirement on this drug.

ShortPrior Authorization
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Prior Authorization) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Basic.extension:usdf-PriorAuthorizationNewStartsOnly-extension
Slice Nameusdf-PriorAuthorizationNewStartsOnly-extension
Definition

A Boolean indication of whether the coverage plan imposes a prior authorization requirement on this drug for new starts only. (Only include if PriorAuthorization = true)

ShortPrior Authorization New Starts Only
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Prior Authorization New Starts Only) (Extension Type: boolean)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
24. Basic.extension:usdf-StepTherapyLimit-extension
Slice Nameusdf-StepTherapyLimit-extension
Definition

A boolean indicating whether the coverage plan imposes a step therapy requirement on this drug meaning another drug may need to be tried beforehand.

ShortStep Therapy Limit
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Step Therapy Limit) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Basic.extension:usdf-StepTherapyLimitNewStartsOnly-extension
Slice Nameusdf-StepTherapyLimitNewStartsOnly-extension
Definition

A boolean indicating whether the coverage plan imposes a step therapy requirement on this drug meaning another drug may need to be tried beforehand for new starts only (Not required if patient has previously met step therapy requirements). (Only include if StepTherapyLimit = true)

ShortStep Therapy Limit New Starts Only
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Step Therapy Limit New Starts Only) (Extension Type: boolean)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. Basic.extension:usdf-QuantityLimit-extension
Slice Nameusdf-QuantityLimit-extension
Definition

A Boolean indication of whether the coverage plan imposes a quantity limit on this drug.

ShortQuantity Limit
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Quantity Limit) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. Basic.extension:usdf-QuantityLimitDetail-extension
Slice Nameusdf-QuantityLimitDetail-extension
Definition

A detailed definition of the quantity limits the coverage plan imposes on this drug. These limit details may include (potentially including a rolling dispense limit, maximum daily, or therapy days for a period of time. (Only include if QuantityLimit = true)

ShortQuantity Limit Detail
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Quantity Limit Detail) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Basic.extension:usdf-AdditionalCoverageInformation-extension
Slice Nameusdf-AdditionalCoverageInformation-extension
Definition

Additional drug coverage information that may include conditional coverage requirements such as a diagnosis pre-requisite, additional drug specific cost sharing information, or other coverage details not otherwise indicated.

ShortAdditional Coverage Information
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Additional Coverage Information) (Extension Type: markdown)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Basic.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Basic.code
Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

ShortKind of Resource
Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

Control1..1
BindingFor example codes, see BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-type

Codes for identifying types of resources not yet defined by FHIR.

TypeCodeableConcept
Is Modifiertrue because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Summarytrue
Requirements

Must be able to distinguish different types of Basic resources.

Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-InsuranceItemTypeCS&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;formulary-item&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
38. Basic.subject
Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

ShortIdentifies the focus of this resource
Comments

Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Control10..1
TypeReference(Formulary Drug, Resource)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Needed for partitioning the resource by Patient.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Basic
Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

ShortResource for non-supported content
Control0..*
Is Modifierfalse
Summaryfalse
Alternate NamesZ-resource, Extension-resource, Custom-resource
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Basic.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. Basic.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. Basic.meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
8. Basic.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Basic.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
10. Basic.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

ShortVersion specific identifier
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Control0..1
Typeid
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Basic.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

ShortWhen the resource version last changed
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

Control1..1
Typeinstant
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Basic.meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

ShortIdentifies where the resource comes from
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Control0..1
Typeuri
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Basic.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control0..*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Basic.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

ShortSecurity Labels applied to this resource
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
BindingUnless not suitable, these codes SHALL be taken from All Security Labels

Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Basic.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

ShortTags applied to this resource
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Control0..*
BindingFor example codes, see CommonTags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

TypeCoding
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. Basic.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
24. Basic.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
26. Basic.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Basic.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
30. Basic.extension
Definition

An Extension

ShortExtension
Control4..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Basic.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. Basic.extension:usdf-FormularyReference-extension
Slice Nameusdf-FormularyReference-extension
Definition

Reference to the formulary this item belongs to.

ShortFormulary Reference
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Formulary Reference) (Extension Type: Reference(Formulary))
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Basic.extension:usdf-AvailabilityStatus-extension
Slice Nameusdf-AvailabilityStatus-extension
Definition

A boolean indicating whether the formulary item is currently available under the formulary. Drugs may appear on a formulary, but not considered "active" for the current year. Drugs may also be removed during the course of a plan year.

ShortAvailability Status
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Availability Status) (Extension Type: code)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Basic.extension:usdf-AvailabilityPeriod-extension
Slice Nameusdf-AvailabilityPeriod-extension
Definition

The period for which this item is available on the formulary. Drugs may appear on a formulary, but not considered "active" for the current year.

ShortAvailability Period
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Availability Period) (Extension Type: Period)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. Basic.extension:usdf-PharmacyBenefitType-extension
Slice Nameusdf-PharmacyBenefitType-extension
Definition

A CodeableConcept indicating the pharmacy benefit type the formulary drug is available through the associated plan. This pharmacy benefit type is specific to the FormularyDrug and indicates which of the pharmacy benefit type from the plan applies to the particular formulary drug.

ShortPharmacy Benefit Type
Control1..*
This element is affected by the following invariants: ele-1
TypeExtension(Pharmacy Benefit Type) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. Basic.extension:usdf-DrugTierID-extension
Slice Nameusdf-DrugTierID-extension
Definition

A code that describes the coverage status of a drug in a health plan (e.g., preferred generic, specialty, etc.)

ShortDrug Tier ID
Control1..1
This element is affected by the following invariants: ele-1
TypeExtension(Drug Tier ID) (Extension Type: CodeableConcept)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
42. Basic.extension:usdf-PriorAuthorization-extension
Slice Nameusdf-PriorAuthorization-extension
Definition

A Boolean indication of whether the coverage plan imposes a prior authorization requirement on this drug.

ShortPrior Authorization
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Prior Authorization) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
44. Basic.extension:usdf-PriorAuthorizationNewStartsOnly-extension
Slice Nameusdf-PriorAuthorizationNewStartsOnly-extension
Definition

A Boolean indication of whether the coverage plan imposes a prior authorization requirement on this drug for new starts only. (Only include if PriorAuthorization = true)

ShortPrior Authorization New Starts Only
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Prior Authorization New Starts Only) (Extension Type: boolean)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. Basic.extension:usdf-StepTherapyLimit-extension
Slice Nameusdf-StepTherapyLimit-extension
Definition

A boolean indicating whether the coverage plan imposes a step therapy requirement on this drug meaning another drug may need to be tried beforehand.

ShortStep Therapy Limit
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Step Therapy Limit) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
48. Basic.extension:usdf-StepTherapyLimitNewStartsOnly-extension
Slice Nameusdf-StepTherapyLimitNewStartsOnly-extension
Definition

A boolean indicating whether the coverage plan imposes a step therapy requirement on this drug meaning another drug may need to be tried beforehand for new starts only (Not required if patient has previously met step therapy requirements). (Only include if StepTherapyLimit = true)

ShortStep Therapy Limit New Starts Only
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Step Therapy Limit New Starts Only) (Extension Type: boolean)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
50. Basic.extension:usdf-QuantityLimit-extension
Slice Nameusdf-QuantityLimit-extension
Definition

A Boolean indication of whether the coverage plan imposes a quantity limit on this drug.

ShortQuantity Limit
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Quantity Limit) (Extension Type: boolean)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
52. Basic.extension:usdf-QuantityLimitDetail-extension
Slice Nameusdf-QuantityLimitDetail-extension
Definition

A detailed definition of the quantity limits the coverage plan imposes on this drug. These limit details may include (potentially including a rolling dispense limit, maximum daily, or therapy days for a period of time. (Only include if QuantityLimit = true)

ShortQuantity Limit Detail
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Quantity Limit Detail) (Complex Extension)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
54. Basic.extension:usdf-AdditionalCoverageInformation-extension
Slice Nameusdf-AdditionalCoverageInformation-extension
Definition

Additional drug coverage information that may include conditional coverage requirements such as a diagnosis pre-requisite, additional drug specific cost sharing information, or other coverage details not otherwise indicated.

ShortAdditional Coverage Information
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Additional Coverage Information) (Extension Type: markdown)
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
56. Basic.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
58. Basic.identifier
Definition

Identifier assigned to the resource for business purposes, outside the context of FHIR.

ShortBusiness identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
60. Basic.code
Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

ShortKind of Resource
Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

Control1..1
BindingFor example codes, see BasicResourceTypes

Codes for identifying types of resources not yet defined by FHIR.

TypeCodeableConcept
Is Modifiertrue because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Summarytrue
Requirements

Must be able to distinguish different types of Basic resources.

Pattern Value&lt;valueCodeableConcept&nbsp;xmlns=&quot;http://hl7.org/fhir&quot;&gt;<br/>&nbsp;&nbsp;&lt;coding&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;system&nbsp;value=&quot;http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-InsuranceItemTypeCS&quot;/&gt;<br/>&nbsp;&nbsp;&nbsp;&nbsp;&lt;code&nbsp;value=&quot;formulary-item&quot;/&gt;<br/>&nbsp;&nbsp;&lt;/coding&gt;<br/>&lt;/valueCodeableConcept&gt;<br/>
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
62. Basic.subject
Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

ShortIdentifies the focus of this resource
Comments

Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Control1..1
TypeReference(Formulary Drug)
Is Modifierfalse
Must Supporttrue
Summarytrue
Requirements

Needed for partitioning the resource by Patient.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
64. Basic.created
Definition

Identifies when the resource was first created.

ShortWhen created
Control0..1
Typedate
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Requirements

Allows ordering resource instances by time.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. Basic.author
Definition

Indicates who was responsible for creating the resource instance.

ShortWho created
Control0..1
TypeReference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization)
Is Modifierfalse
Summarytrue
Requirements

Needed for partitioning the resource.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))