DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.0.1 - STU 2
DaVinci Payer Data Exchange (PDex) US Drug Formulary
2.0.1 - STU 2
This page is part of the US Drug Formulary (v2.0.1: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyBulkDataGraphDefinition | Version: 2.0.1 | |||
| 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
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 |
 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 |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. 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. 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| GraphDefinition.status | required | Pattern: active |
| GraphDefinition.start | required | Pattern: InsurancePlan |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition | C | 0..* | GraphDefinition | Definition of a graph of resources | ||||
| 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.
| |||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| GraphDefinition.language | preferred | CommonLanguages
| ||||
| GraphDefinition.status | required | Pattern: active | ||||
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| GraphDefinition.start | required | Pattern: InsurancePlan | ||||
| GraphDefinition.link.target.type | required | Pattern: Basic | ||||
| GraphDefinition.link.target.compartment.use | required | GraphCompartmentUse | ||||
| GraphDefinition.link.target.compartment.code | required | CompartmentType | ||||
| GraphDefinition.link.target.compartment.rule | required | GraphCompartmentRule | ||||
| GraphDefinition.link.target.link.target.type | required | Pattern: MedicationKnowledge | ||||
| GraphDefinition.link.target.link.target.compartment.use | required | GraphCompartmentUse | ||||
| GraphDefinition.link.target.link.target.compartment.code | required | CompartmentType | ||||
| GraphDefinition.link.target.link.target.compartment.rule | required | GraphCompartmentRule |
This structure is derived from GraphDefinition
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 | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| GraphDefinition | C | 0..* | GraphDefinition | Definition of a graph of resources |
| 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 |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. 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. 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| GraphDefinition.status | required | Pattern: active |
| GraphDefinition.start | required | Pattern: InsurancePlan |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| GraphDefinition | C | 0..* | GraphDefinition | Definition of a graph of resources | ||||
| 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.
| |||||
| 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| GraphDefinition.language | preferred | CommonLanguages
| ||||
| GraphDefinition.status | required | Pattern: active | ||||
| GraphDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| GraphDefinition.start | required | Pattern: InsurancePlan | ||||
| GraphDefinition.link.target.type | required | Pattern: Basic | ||||
| GraphDefinition.link.target.compartment.use | required | GraphCompartmentUse | ||||
| GraphDefinition.link.target.compartment.code | required | CompartmentType | ||||
| GraphDefinition.link.target.compartment.rule | required | GraphCompartmentRule | ||||
| GraphDefinition.link.target.link.target.type | required | Pattern: MedicationKnowledge | ||||
| GraphDefinition.link.target.link.target.compartment.use | required | GraphCompartmentUse | ||||
| GraphDefinition.link.target.link.target.compartment.code | required | CompartmentType | ||||
| GraphDefinition.link.target.link.target.compartment.rule | required | GraphCompartmentRule |
This structure is derived from GraphDefinition
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Pharmacy. Package hl7.fhir.us.davinci-drug-formulary#2.0.1 based on FHIR 4.0.1. Generated 2023-12-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change