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
Page standards status: Informative |
Parameter | Type | Conf. | Description | Example |
---|---|---|---|---|
_id | token | SHALL | FHIR resource id of an InsurancePlan | GET [base]/InsurancePlan?_id=[id] |
_lastUpdated | date | SHALL | Accesses the last updated date of an InsurancePlan | GET [base]/InsurancePlan?_lastUpdated=[date] |
identifier | token | SHALL | Accesses the business identifier of an InsurancePlan | GET [base]/InsurancePlan?identifier=[system]|[code] |
status | token | SHALL | Accesses the status of an InsurancePlan | GET [base]/InsurancePlan?status=[code] |
period | date | SHALL | Accesses the active period of an InsurancePlan | GET [base]/InsurancePlan?period=[date] |
type | token | SHALL | Accesses the Type of an InsurancePlan | GET [base]/InsurancePlan?type=[system]|[code] |
name | string | SHALL | Accesses the name of an InsurancePlan | GET [base]/InsurancePlan?name=[string] |
coverage-type | token | SHALL | Accesses the coverage type of an InsurancePlan | GET [base]/InsurancePlan?coverage-type=[system]|[code] |
formulary-coverage | reference | SHALL | Accesses the Coverage Formulary Reference of an InsurancePlan | GET [base]/InsurancePlan?formulary-coverage=[reference] |
coverage-area | reference | SHALL | Search InsurancePlan by coverage location. | GET [base]/InsurancePlan?coverage-area=[reference] |
Parameter | Type | Conf. | Description | Example |
---|---|---|---|---|
_id | token | SHALL | FHIR resource id of a Location | GET [base]/Location?_id=[id] |
_lastUpdated | date | SHOULD | Access the last updated date of a Location | GET [base]/Location?_lastUpdated=[date] |
address | string | SHOULD | Access the address of a Location | GET [base]/Location?address=[string] |
address-city | string | SHOULD | Access the city of a Location | GET [base]/Location?address-city=[string] |
address-state | string | SHOULD | Access the state of a Location | GET [base]/Location?address-state=[string] |
address-postalcode | string | SHOULD | Access the postal code of a Location | GET [base]/Location?address-postalcode=[string] |
Parameter | Type | Conf. | Description | Example |
---|---|---|---|---|
_id | token | SHALL | FHIR resource id of a FormularyItem | GET [base]/Basic?_id=[id] |
_lastUpdated | date | SHALL | Accesses the last updated date of a FormularyItem | GET [base]/Basic?_lastUpdated=[date] |
code | token | SHALL | Accesses the Code of a Basis resource to find a FormularyItem | GET [base]/Basic?code=formulary-item |
subject | reference | SHALL | Accesses the subject FormularyDrug (MedicationKnowledge) reference of a FormularyItem | GET [base]/Basic?subject=[reference] |
status | token | SHALL | Accesses the status of a FormularyItem | GET [base]/Basic?status=[code] |
period | date | SHALL | Accesses the active period of a FormularyItem | GET [base]/Basic?period=[date] |
formulary | reference | SHALL | Accesses the formulary reference of a FormularyItem | GET [base]/Basic?formulary=[reference] |
pharmacy-benefit-type | token | SHALL | Accesses the Pharmacy Benefit Type of a FormularyItem | GET [base]/Basic?pharmacy-benefit-type=[system]|[code] |
drug-tier | token | SHALL | Accesses the Drug Tier of a FormularyItem | GET [base]/Basic?drug-tier=[system]|[code] |
Parameter | Type | Conf. | Description | Example |
---|---|---|---|---|
_id | token | SHALL | FHIR resource id of a FormularyDrug | GET [base]/MedicationKnowledge?_id=[id] |
_lastUpdated | date | SHALL | Accesses the last updated date of a FormularyItem | GET [base]/MedicationKnowledge?_lastUpdated=[date] |
status | token | SHALL | Accesses the status of a FormularyDrug | GET [base]/MedicationKnowledge?status=[code] |
code | token | SHALL | Accesses the status of a FormularyDrug | GET [base]/MedicationKnowledge?code=[system]|[code] |
drug-name | string | SHALL | Accesses the Drug Name of a FormularyDrug | GET [base]/MedicationKnowledge?drug-name=[string] |
doseform | token | SHOULD | Accesses the dose form of a FormularyDrug | GET [base]/MedicationKnowledge?doseform=[system|code] |