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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Formulary Bulk Data Graph Definition

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

Usage:

• Examples for this Resource Profile: FormularyGraphDefinition

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
GraphDefinition	C	0..*	GraphDefinition	Definition of a graph of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	ΣC	1..1	string	Name for this graph definition (computer friendly) ele-1: All FHIR elements must have a @value or children Required Pattern: FormularyGraphDefinition
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children Required Pattern: active
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. ele-1: All FHIR elements must have a @value or children Required Pattern: InsurancePlan
profile		0..1	canonical(StructureDefinition)	Profile on base resource ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
GraphDefinition.status	required	Pattern: active http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
GraphDefinition.start	required	Pattern: InsurancePlan http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard

This structure is derived from GraphDefinition

Name	Flags	Card.	Type	Description & Constraints
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
profile		0..1	canonical(StructureDefinition)	Profile on base resource Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
GraphDefinition.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
GraphDefinition.status	required	Pattern: active http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
GraphDefinition.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
GraphDefinition.start	required	Pattern: InsurancePlan http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
GraphDefinition.link.target.type	required	Pattern: Basic http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
GraphDefinition.link.target.compartment.use	required	GraphCompartmentUse http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1 from the FHIR Standard
GraphDefinition.link.target.compartment.code	required	CompartmentType http://hl7.org/fhir/ValueSet/compartment-type|4.0.1 from the FHIR Standard
GraphDefinition.link.target.compartment.rule	required	GraphCompartmentRule http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.type	required	Pattern: MedicationKnowledge http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.use	required	GraphCompartmentUse http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.code	required	CompartmentType http://hl7.org/fhir/ValueSet/compartment-type|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.rule	required	GraphCompartmentRule http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1 from the FHIR Standard

This structure is derived from GraphDefinition

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
GraphDefinition	C	0..*	GraphDefinition	Definition of a graph of resources dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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 ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name	ΣC	1..1	string	Name for this graph definition (computer friendly) ele-1: All FHIR elements must have a @value or children Required Pattern: FormularyGraphDefinition
status	?!Σ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children Required Pattern: active
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. ele-1: All FHIR elements must have a @value or children Required Pattern: InsurancePlan
profile		0..1	canonical(StructureDefinition)	Profile on base resource ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
GraphDefinition.status	required	Pattern: active http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
GraphDefinition.start	required	Pattern: InsurancePlan http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard

Differential View

This structure is derived from GraphDefinition

Name	Flags	Card.	Type	Description & Constraints
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
profile		0..1	canonical(StructureDefinition)	Profile on base resource Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
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
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
GraphDefinition.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
GraphDefinition.status	required	Pattern: active http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
GraphDefinition.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
GraphDefinition.start	required	Pattern: InsurancePlan http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
GraphDefinition.link.target.type	required	Pattern: Basic http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
GraphDefinition.link.target.compartment.use	required	GraphCompartmentUse http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1 from the FHIR Standard
GraphDefinition.link.target.compartment.code	required	CompartmentType http://hl7.org/fhir/ValueSet/compartment-type|4.0.1 from the FHIR Standard
GraphDefinition.link.target.compartment.rule	required	GraphCompartmentRule http://hl7.org/fhir/ValueSet/graph-compartment-rule|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.type	required	Pattern: MedicationKnowledge http://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.use	required	GraphCompartmentUse http://hl7.org/fhir/ValueSet/graph-compartment-use|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.code	required	CompartmentType http://hl7.org/fhir/ValueSet/compartment-type|4.0.1 from the FHIR Standard
GraphDefinition.link.target.link.target.compartment.rule	required	GraphCompartmentRule 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