OPERATION: Prescribable Product Formulary Lookup
The official URL for this operation definition is:
http://prescribeit.ca/fhir/OperationDefinition/formulary
This operation provides a means of looking up the formulary status of a specified medication in a specified jurisdiction, as well as identifying approximate cost for the medication. This information can be used to aid prescribing decisions.
URL: [base]/$formulary
Parameters
Use | Name | Cardinality | Type | Binding | Documentation |
IN | jurisdiction | 1..1 | code | https://fhir.infoway-inforoute.ca/ValueSet/canadianjurisdiction|20170626 (Required) | The code for the jurisdiction whose formulary is being checked. (This will generally be the jurisdiction in which the pharmacy operates, though it may vary for online or border pharmacies. |
IN | product | 1..1 | code | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (Extensible) | The code for the drug or natural health product to be looked up in the formulary. This may be a code for a specific manufactured product or a more general code. If a more general code is provided, coverage information will be returned for all associated manufactured products with entries in the formulary. |
IN | representative-din | 0..1 | boolean | This boolean (allowed values are 'true' and 'false') may only be sent if the product is a DIN. I.e. If the 'system' portion of the product parameter matches the URL 'http://hl7.org/fhir/sid/ca-hc-din'. If set to true, it indicates that the search should match on all products having the same formulation as the specified manufactured product, regardless of manufacturer or packaging. | |
OUT | product | 0..* | A manufactured medication found in the jurisdictional formulary associated with the requested drug. (There will be a maximum of one repetition if the search was for a manufactured product, but there may be more if the search was for a higher-level product.) | ||
OUT | product.code | 1..1 | Coding | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct (Extensible) | The code and name of the product |
OUT | product.coverage | 1..1 | CodeableConcept | https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicationcoverage|20220331 (Required) | A code indicating whether the specified product is covered within the specified jurisdiction's formulary |
OUT | product.costSymbol | 0..1 | string | A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+') | |
OUT | product.unitCost | 0..1 | Quantity | The estimated cost of a unit of the product in dollars NOTE: This element is being included for potential future use only. It is not supported in this release | |
OUT | product.costRange | 0..1 | string | A dollar range expressing the expected unit cost of the product (e.g. '$10-20') | |
OUT | product.costUnit | 0..1 | string | The quantity of the drug associated with the cost symbol and cost range (e.g. 'per mg' or 'per 28 tablet package') | |
OUT | product.manufacturedProductUrl | 0..1 | uri | A link to a web page or document where additional information can be found about the manufactured product | |
OUT | product.conditionalCoverageUrl | 0..1 | uri | A link to a web page or document where additional information can be found about the formulary's conditional coverage rules |