DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.1.0 - STU 3 (ci-build) 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.1.0 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: Formulary Bulk Data Graph Definition

Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyBulkDataGraphDefinition Version: 2.1.0
Standards status: Draft Computable Name: FormularyBulkDataGraphDefinition

A GraphDefinition defining a graph of resources to return in a query for a Formulary related Bulk Data request.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from GraphDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 0..* GraphDefinition Definition of a graph of resources
... name 1..1 string Name for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... status 1..1 code draft | active | retired | unknown
Required Pattern: active
... start 1..1 code Type of resource at which the graph starts
Required Pattern: InsurancePlan
... link
.... target
..... type 1..1 code Type of resource this link refers to
Required Pattern: Basic
..... params 0..1 string Criteria for reverse lookup
Required Pattern: formulary={ref}
..... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem
..... link 0..* BackboneElement Additional links from target resource
...... path 0..1 string Path in the resource that contains the link
Required Pattern: Basic.subject
...... target
....... type 1..1 code Type of resource this link refers to
Required Pattern: MedicationKnowledge
....... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* GraphDefinition Definition of a graph of resources
gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... name ΣC 1..1 string Name for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... start Σ 1..1 code Type of resource at which the graph starts
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: InsurancePlan
... profile 0..1 canonical(StructureDefinition) Profile on base resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
GraphDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
GraphDefinition.startrequiredPattern: InsurancePlan
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* GraphDefinition Definition of a graph of resources
gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this graph definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the graph definition
... name ΣC 1..1 string Name for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the graph definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this graph definition is defined
... start Σ 1..1 code Type of resource at which the graph starts
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: InsurancePlan
... profile 0..1 canonical(StructureDefinition) Profile on base resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
... link 0..* BackboneElement Links this graph makes rules about
.... 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
.... path 0..1 string Path in the resource that contains the link
.... sliceName 0..1 string Which slice (if profiled)
.... min 0..1 integer Minimum occurrences for this link
.... max 0..1 string Maximum occurrences for this link
.... description 0..1 string Why this link is specified
.... target 0..* BackboneElement Potential target for the link
..... 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
..... type 1..1 code Type of resource this link refers to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: Basic
..... params 0..1 string Criteria for reverse lookup
Required Pattern: formulary={ref}
..... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem
..... compartment 0..* BackboneElement Compartment Consistency Rules
...... 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
...... use 1..1 code condition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

...... code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.

...... rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.

...... expression 0..1 string Custom rule, as a FHIRPath expression
...... description 0..1 string Documentation for FHIRPath expression
..... link 0..* BackboneElement Additional links from target resource
...... 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
...... path 0..1 string Path in the resource that contains the link
Required Pattern: Basic.subject
...... sliceName 0..1 string Which slice (if profiled)
...... min 0..1 integer Minimum occurrences for this link
...... max 0..1 string Maximum occurrences for this link
...... description 0..1 string Why this link is specified
...... target 0..* BackboneElement Potential target for the link
....... 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
....... type 1..1 code Type of resource this link refers to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: MedicationKnowledge
....... params 0..1 string Criteria for reverse lookup
....... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
....... compartment 0..* BackboneElement Compartment Consistency Rules
........ 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
........ use 1..1 code condition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

........ code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.

........ rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.

........ expression 0..1 string Custom rule, as a FHIRPath expression
........ description 0..1 string Documentation for FHIRPath expression
....... link 0..* See link (GraphDefinition) Additional links from target resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
GraphDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GraphDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
GraphDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
GraphDefinition.startrequiredPattern: InsurancePlan
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
GraphDefinition.link.target.typerequiredPattern: Basic
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
GraphDefinition.link.target.compartment.userequiredGraphCompartmentUse
http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1
from the FHIR Standard
GraphDefinition.link.target.compartment.coderequiredCompartmentType
http://hl7.org/fhir/ValueSet/compartment-type|4.0.1
from the FHIR Standard
GraphDefinition.link.target.compartment.rulerequiredGraphCompartmentRule
http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.typerequiredPattern: MedicationKnowledge
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.userequiredGraphCompartmentUse
http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.coderequiredCompartmentType
http://hl7.org/fhir/ValueSet/compartment-type|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.rulerequiredGraphCompartmentRule
http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1
from the FHIR Standard

This structure is derived from GraphDefinition

Summary

Differential View

This structure is derived from GraphDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 0..* GraphDefinition Definition of a graph of resources
... name 1..1 string Name for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... status 1..1 code draft | active | retired | unknown
Required Pattern: active
... start 1..1 code Type of resource at which the graph starts
Required Pattern: InsurancePlan
... link
.... target
..... type 1..1 code Type of resource this link refers to
Required Pattern: Basic
..... params 0..1 string Criteria for reverse lookup
Required Pattern: formulary={ref}
..... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem
..... link 0..* BackboneElement Additional links from target resource
...... path 0..1 string Path in the resource that contains the link
Required Pattern: Basic.subject
...... target
....... type 1..1 code Type of resource this link refers to
Required Pattern: MedicationKnowledge
....... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* GraphDefinition Definition of a graph of resources
gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... name ΣC 1..1 string Name for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... start Σ 1..1 code Type of resource at which the graph starts
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: InsurancePlan
... profile 0..1 canonical(StructureDefinition) Profile on base resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
GraphDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
GraphDefinition.startrequiredPattern: InsurancePlan
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition C 0..* GraphDefinition Definition of a graph of resources
gdf-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this graph definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the graph definition
... name ΣC 1..1 string Name for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the graph definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1 markdown Why this graph definition is defined
... start Σ 1..1 code Type of resource at which the graph starts
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: InsurancePlan
... profile 0..1 canonical(StructureDefinition) Profile on base resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
... link 0..* BackboneElement Links this graph makes rules about
.... 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
.... path 0..1 string Path in the resource that contains the link
.... sliceName 0..1 string Which slice (if profiled)
.... min 0..1 integer Minimum occurrences for this link
.... max 0..1 string Maximum occurrences for this link
.... description 0..1 string Why this link is specified
.... target 0..* BackboneElement Potential target for the link
..... 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
..... type 1..1 code Type of resource this link refers to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: Basic
..... params 0..1 string Criteria for reverse lookup
Required Pattern: formulary={ref}
..... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem
..... compartment 0..* BackboneElement Compartment Consistency Rules
...... 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
...... use 1..1 code condition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

...... code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.

...... rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.

...... expression 0..1 string Custom rule, as a FHIRPath expression
...... description 0..1 string Documentation for FHIRPath expression
..... link 0..* BackboneElement Additional links from target resource
...... 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
...... path 0..1 string Path in the resource that contains the link
Required Pattern: Basic.subject
...... sliceName 0..1 string Which slice (if profiled)
...... min 0..1 integer Minimum occurrences for this link
...... max 0..1 string Maximum occurrences for this link
...... description 0..1 string Why this link is specified
...... target 0..* BackboneElement Potential target for the link
....... 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
....... type 1..1 code Type of resource this link refers to
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.


Required Pattern: MedicationKnowledge
....... params 0..1 string Criteria for reverse lookup
....... profile 0..1 canonical(StructureDefinition) Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
....... compartment 0..* BackboneElement Compartment Consistency Rules
........ 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
........ use 1..1 code condition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

........ code 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Identifies a compartment.

........ rule 1..1 code identical | matching | different | custom
Binding: GraphCompartmentRule (required): How a compartment must be linked.

........ expression 0..1 string Custom rule, as a FHIRPath expression
........ description 0..1 string Documentation for FHIRPath expression
....... link 0..* See link (GraphDefinition) Additional links from target resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
GraphDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
GraphDefinition.statusrequiredPattern: active
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
GraphDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
GraphDefinition.startrequiredPattern: InsurancePlan
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
GraphDefinition.link.target.typerequiredPattern: Basic
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
GraphDefinition.link.target.compartment.userequiredGraphCompartmentUse
http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1
from the FHIR Standard
GraphDefinition.link.target.compartment.coderequiredCompartmentType
http://hl7.org/fhir/ValueSet/compartment-type|4.0.1
from the FHIR Standard
GraphDefinition.link.target.compartment.rulerequiredGraphCompartmentRule
http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.typerequiredPattern: MedicationKnowledge
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.userequiredGraphCompartmentUse
http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.coderequiredCompartmentType
http://hl7.org/fhir/ValueSet/compartment-type|4.0.1
from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.rulerequiredGraphCompartmentRule
http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1
from the FHIR Standard

This structure is derived from GraphDefinition

Summary

 

Other representations of profile: CSV, Excel, Schematron