DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.0.0 - STU 2 US

This page is part of the US Drug Formulary (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, 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.0.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

Summary

This structure is derived from GraphDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition 0..*GraphDefinitionDefinition of a graph of resources
... name 1..1stringName for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... status 1..1codedraft | active | retired | unknown
Required Pattern: active
... start 1..1codeType of resource at which the graph starts
Required Pattern: InsurancePlan
... link
.... target
..... type 1..1codeType of resource this link refers to
Required Pattern: Basic
..... params 0..1stringCriteria for reverse lookup
Required Pattern: formulary={ref}
..... profile 0..1canonical(StructureDefinition)Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem
..... link 0..*BackboneElementAdditional links from target resource
...... path 0..1stringPath in the resource that contains the link
Required Pattern: Basic.subject
...... target
....... type 1..1codeType of resource this link refers to
Required Pattern: MedicationKnowledge
....... profile 0..1canonical(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 I0..*GraphDefinitionDefinition of a graph of resources
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the graph definition
... name ΣI1..1stringName for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the graph definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this graph definition is defined
... start Σ1..1codeType 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..1canonical(StructureDefinition)Profile on base resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
... link 0..*BackboneElementLinks this graph makes rules about
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 0..1stringPath in the resource that contains the link
.... sliceName 0..1stringWhich slice (if profiled)
.... min 0..1integerMinimum occurrences for this link
.... max 0..1stringMaximum occurrences for this link
.... description 0..1stringWhy this link is specified
.... target 0..*BackboneElementPotential target for the link
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codeType 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..1stringCriteria for reverse lookup
Required Pattern: formulary={ref}
..... profile 0..1canonical(StructureDefinition)Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem
..... compartment 0..*BackboneElementCompartment Consistency Rules
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... use 1..1codecondition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

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

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

...... expression 0..1stringCustom rule, as a FHIRPath expression
...... description 0..1stringDocumentation for FHIRPath expression
..... link 0..*BackboneElementAdditional links from target resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... path 0..1stringPath in the resource that contains the link
Required Pattern: Basic.subject
...... sliceName 0..1stringWhich slice (if profiled)
...... min 0..1integerMinimum occurrences for this link
...... max 0..1stringMaximum occurrences for this link
...... description 0..1stringWhy this link is specified
...... target 0..*BackboneElementPotential target for the link
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1codeType 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..1stringCriteria for reverse lookup
....... profile 0..1canonical(StructureDefinition)Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
....... compartment 0..*BackboneElementCompartment Consistency Rules
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ use 1..1codecondition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

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

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

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

doco Documentation for this format

This structure is derived from GraphDefinition

Summary

Differential View

This structure is derived from GraphDefinition

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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. GraphDefinition I0..*GraphDefinitionDefinition of a graph of resources
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this graph definition, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the graph definition
... name ΣI1..1stringName for this graph definition (computer friendly)
Required Pattern: FormularyGraphDefinition
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


Required Pattern: active
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the graph definition
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for graph definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this graph definition is defined
... start Σ1..1codeType 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..1canonical(StructureDefinition)Profile on base resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary
... link 0..*BackboneElementLinks this graph makes rules about
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... path 0..1stringPath in the resource that contains the link
.... sliceName 0..1stringWhich slice (if profiled)
.... min 0..1integerMinimum occurrences for this link
.... max 0..1stringMaximum occurrences for this link
.... description 0..1stringWhy this link is specified
.... target 0..*BackboneElementPotential target for the link
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type 1..1codeType 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..1stringCriteria for reverse lookup
Required Pattern: formulary={ref}
..... profile 0..1canonical(StructureDefinition)Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem
..... compartment 0..*BackboneElementCompartment Consistency Rules
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... use 1..1codecondition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

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

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

...... expression 0..1stringCustom rule, as a FHIRPath expression
...... description 0..1stringDocumentation for FHIRPath expression
..... link 0..*BackboneElementAdditional links from target resource
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... path 0..1stringPath in the resource that contains the link
Required Pattern: Basic.subject
...... sliceName 0..1stringWhich slice (if profiled)
...... min 0..1integerMinimum occurrences for this link
...... max 0..1stringMaximum occurrences for this link
...... description 0..1stringWhy this link is specified
...... target 0..*BackboneElementPotential target for the link
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... type 1..1codeType 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..1stringCriteria for reverse lookup
....... profile 0..1canonical(StructureDefinition)Profile for the target resource
Required Pattern: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug
....... compartment 0..*BackboneElementCompartment Consistency Rules
........ id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ use 1..1codecondition | requirement
Binding: GraphCompartmentUse (required): Defines how a compartment rule is used.

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

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

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

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
GraphDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
GraphDefinition.statusrequiredPattern: active
GraphDefinition.jurisdictionextensibleJurisdiction ValueSet
GraphDefinition.startrequiredPattern: InsurancePlan
GraphDefinition.link.target.typerequiredPattern: Basic
GraphDefinition.link.target.compartment.userequiredGraphCompartmentUse
GraphDefinition.link.target.compartment.coderequiredCompartmentType
GraphDefinition.link.target.compartment.rulerequiredGraphCompartmentRule
GraphDefinition.link.target.link.target.typerequiredPattern: MedicationKnowledge
GraphDefinition.link.target.link.target.compartment.userequiredGraphCompartmentUse
GraphDefinition.link.target.link.target.compartment.coderequiredCompartmentType
GraphDefinition.link.target.link.target.compartment.rulerequiredGraphCompartmentRule