3. FHIR Server Interaction
The server is read only and only allows the retrieval of patient/user's data through authenticated access. The data retrieved from the server is returned in JSON format.
Server Base URL: https://davinci-drug-formulary-ri.logicahealth.org/fhir
Throughout this documentation, the server's route
[base]refers to the above base url.
The authenticated access follows the SMART on FHIR App Launch Framework "standalone launch" workflow. The available scopes are:
patient/*.readuser/*.readoffline_accesslaunch/patientopenidfhirUser
A given application and request for access token can have have multiple scopes, which must be space-separated.
The capability statement is available at [base]/metadata:
Click to expand JSON snippet
{
"resourceType": "CapabilityStatement",
"version": "1.2.0",
"title": "Da Vinci US Drug Formulary Reference Implementation",
"status": "draft",
"experimental": true,
"date": "2022-04-05T00:00:00+00:00",
"publisher": "Da Vinci",
"kind": "instance",
"instantiates": [
"http://hl7.org/fhir/us/davinci-drug-formulary/CapabilityStatement/usdf-server"
],
"software": {
"name": "https://github.com/HL7-DaVinci/drug-formulary-ri"
},
"implementation": {
"description": "Da Vinci Drug Formulary Reference Server",
"url": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/"
},
"fhirVersion": "4.0.0",
"format": [
"application/fhir+xml",
"application/fhir+json"
],
"implementationGuide": [
"http://hl7.org/fhir/us/davinci-drug-formulary/ImplementationGuide/hl7.fhir.us.davinci-drug-formulary",
"https://wiki.hl7.org/Da_Vinci_PDex-formulary_FHIR_IG_Proposal"
],
"rest": [
{
"mode": "server",
"security": {
"extension": [
{
"url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
"extension": [
{
"url": "authorize",
"valueUri": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/oauth/authorization"
},
{
"url": "introspect",
"valueUri": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/oauth/introspect"
},
{
"url": "token",
"valueUri": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/oauth/token"
}
]
}
],
"service": [
{
"coding": [
{
"system": "http://hl7.org/fhir/restful-security-service",
"code": "SMART-on-FHIR",
"display": "SMART on FHIR"
}
],
"text": "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)"
}
]
},
"resource": [
{
"type": "Basic",
"profile": "http://hl7.org/fhir/StructureDefinition/Basic",
"supportedProfile": [
"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyItem"
],
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"Basic:author",
"Basic:patient",
"Basic:subject"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "Business identifier"
},
{
"name": "drug-tier",
"type": "token",
"documentation": "Accesses the Drug Tier of a FormularyItem"
},
{
"name": "code",
"type": "token",
"documentation": "Kind of Resource"
},
{
"name": "author",
"type": "reference",
"documentation": "Who created"
},
{
"name": "created",
"type": "date",
"documentation": "When created"
},
{
"name": "patient",
"type": "reference",
"documentation": "Identifies the focus of this resource"
},
{
"name": "subject",
"type": "reference",
"documentation": "Identifies the focus of this resource"
},
{
"name": "pharmacy-type",
"type": "token",
"documentation": "Accesses the Pharmacy Network Type of a FormularyItem"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "formulary",
"type": "reference",
"documentation": "Accesses the Formulary of a FormularyItem"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "CodeSystem",
"profile": "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"CodeSystem:supplements"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The code system publication date"
},
{
"name": "identifier",
"type": "token",
"documentation": "External identifier for the code system"
},
{
"name": "code",
"type": "token",
"documentation": "A code defined in the code system"
},
{
"name": "context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the code system"
},
{
"name": "content-mode",
"type": "token",
"documentation": "not-present | example | fragment | complete | supplement"
},
{
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the code system"
},
{
"name": "description",
"type": "string",
"documentation": "The description of the code system"
},
{
"name": "context-type",
"type": "token",
"documentation": "A type of use context assigned to the code system"
},
{
"name": "language",
"type": "token",
"documentation": "A language in which a designation is provided"
},
{
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the code system"
},
{
"name": "version",
"type": "token",
"documentation": "The business version of the code system"
},
{
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the code system"
},
{
"name": "context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the code system"
},
{
"name": "supplements",
"type": "reference",
"documentation": "Find code system supplements for the referenced code system"
},
{
"name": "system",
"type": "uri",
"documentation": "The system for any codes defined by this code system (same as 'url')"
},
{
"name": "context",
"type": "token",
"documentation": "A use context assigned to the code system"
},
{
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the code system"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the code system"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the code system"
},
{
"name": "status",
"type": "token",
"documentation": "The current status of the code system"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "Coverage",
"profile": "http://hl7.org/fhir/StructureDefinition/Coverage",
"supportedProfile": [
"http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage"
],
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"Coverage:beneficiary",
"Coverage:patient",
"Coverage:payor",
"Coverage:policy-holder",
"Coverage:subscriber"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "The primary identifier of the insured and the coverage"
},
{
"name": "subscriber",
"type": "reference",
"documentation": "Reference to the subscriber"
},
{
"name": "type",
"type": "token",
"documentation": "The kind of coverage (health plan, auto, Workers Compensation)"
},
{
"name": "payor",
"type": "reference",
"documentation": "The identity of the insurer or party paying for services"
},
{
"name": "beneficiary",
"type": "reference",
"documentation": "Covered party"
},
{
"name": "patient",
"type": "reference",
"documentation": "Retrieve coverages for a patient"
},
{
"name": "class-value",
"type": "string",
"documentation": "Value of the class (eg. Plan number, group number)"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "class-type",
"type": "token",
"documentation": "Coverage class (eg. plan, group)"
},
{
"name": "dependent",
"type": "string",
"documentation": "Dependent number"
},
{
"name": "policy-holder",
"type": "reference",
"documentation": "Reference to the policyholder"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the Coverage"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "InsurancePlan",
"profile": "http://hl7.org/fhir/StructureDefinition/InsurancePlan",
"supportedProfile": [
"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan",
"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-InsuranceDrugPlan"
],
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"InsurancePlan:administered-by",
"InsurancePlan:endpoint",
"InsurancePlan:owned-by"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
},
{
"name": "address",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
},
{
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "owned-by",
"type": "reference",
"documentation": "An organization of which this organization forms a part"
},
{
"name": "type",
"type": "token",
"documentation": "A code for the type of organization"
},
{
"name": "address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
},
{
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "administered-by",
"type": "reference",
"documentation": "Product administrator"
},
{
"name": "formulary-coverage",
"type": "reference",
"documentation": "Accesses the Coverage Formulary Reference of a PayerInsurancePlan"
},
{
"name": "endpoint",
"type": "reference",
"documentation": "Technical endpoint"
},
{
"name": "coverage-type",
"type": "token",
"documentation": "Accesses the Coverage Type of a PayerInsurancePlan"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of the organization's name or alias"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "status",
"type": "token",
"documentation": "Is the Organization record active"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "Location",
"profile": "http://hl7.org/fhir/StructureDefinition/Location",
"supportedProfile": [
"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-InsurancePlanLocation"
],
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"Location:endpoint",
"Location:organization",
"Location:partof"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "An identifier for the location"
},
{
"name": "partof",
"type": "reference",
"documentation": "A location of which this location is a part"
},
{
"name": "address",
"type": "string",
"documentation": "A (part of the) address of the location"
},
{
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "operational-status",
"type": "token",
"documentation": "Searches for locations (typically bed/room) that have an operational status (e.g. contaminated, housekeeping)"
},
{
"name": "type",
"type": "token",
"documentation": "A code for the type of location"
},
{
"name": "address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
},
{
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the location"
},
{
"name": "organization",
"type": "reference",
"documentation": "Searches for locations that are managed by the provided organization"
},
{
"name": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of the location's name or alias"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "near",
"type": "special",
"documentation": "Search for locations where the location.position is near to, or within a specified distance of, the provided coordinates expressed as [latitude]|[longitude]|[distance]|[units] (using the WGS84 datum, see notes).\nIf the units are omitted, then kms should be assumed. If the distance is omitted, then the server can use its own discretion as to what distances should be considered near (and units are irrelevant)\n\nServers may search using various techniques that might have differing accuracies, depending on implementation efficiency.\n\nRequires the near-distance parameter to be provided also"
},
{
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "status",
"type": "token",
"documentation": "Searches for locations with a specific kind of status"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "MedicationKnowledge",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationKnowledge",
"supportedProfile": [
"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug"
],
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"MedicationKnowledge:ingredient",
"MedicationKnowledge:manufacturer",
"MedicationKnowledge:monograph"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "Code that identifies this medication"
},
{
"name": "ingredient",
"type": "reference",
"documentation": "Medication(s) or substance(s) contained in the medication"
},
{
"name": "doseform",
"type": "token",
"documentation": "powder | tablets | capsule +"
},
{
"name": "classification-type",
"type": "token",
"documentation": "The type of category for the medication (for example, therapeutic classification, therapeutic sub-classification)"
},
{
"name": "monograph-type",
"type": "token",
"documentation": "The category of medication document"
},
{
"name": "classification",
"type": "token",
"documentation": "Specific category assigned to the medication"
},
{
"name": "manufacturer",
"type": "reference",
"documentation": "Manufacturer of the item"
},
{
"name": "ingredient-code",
"type": "token",
"documentation": "Medication(s) or substance(s) contained in the medication"
},
{
"name": "source-cost",
"type": "token",
"documentation": "The source or owner for the price information"
},
{
"name": "drug-name",
"type": "string",
"documentation": "Accesses the Drug Name of a FormularyDrug"
},
{
"name": "monitoring-program-name",
"type": "token",
"documentation": "Name of the reviewing program"
},
{
"name": "monograph",
"type": "reference",
"documentation": "Associated documentation about the medication"
},
{
"name": "monitoring-program-type",
"type": "token",
"documentation": "Type of program under which the medication is monitored"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "status",
"type": "token",
"documentation": "active | inactive | entered-in-error"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "OperationDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"referencePolicy": [
"resolves"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The operation definition publication date"
},
{
"name": "code",
"type": "token",
"documentation": "Name used to invoke the operation"
},
{
"name": "instance",
"type": "token",
"documentation": "Invoke on an instance?"
},
{
"name": "context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the operation definition"
},
{
"name": "kind",
"type": "token",
"documentation": "operation | query"
},
{
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the operation definition"
},
{
"name": "description",
"type": "string",
"documentation": "The description of the operation definition"
},
{
"name": "context-type",
"type": "token",
"documentation": "A type of use context assigned to the operation definition"
},
{
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the operation definition"
},
{
"name": "type",
"type": "token",
"documentation": "Invoke at the type level?"
},
{
"name": "version",
"type": "token",
"documentation": "The business version of the operation definition"
},
{
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the operation definition"
},
{
"name": "context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the operation definition"
},
{
"name": "input-profile",
"type": "reference",
"documentation": "Validation information for in parameters"
},
{
"name": "output-profile",
"type": "reference",
"documentation": "Validation information for out parameters"
},
{
"name": "system",
"type": "token",
"documentation": "Invoke at the system level?"
},
{
"name": "context",
"type": "token",
"documentation": "A use context assigned to the operation definition"
},
{
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the operation definition"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the operation definition"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the operation definition"
},
{
"name": "base",
"type": "reference",
"documentation": "Marks this as a profile of the base"
},
{
"name": "status",
"type": "token",
"documentation": "The current status of the operation definition"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "Organization",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization",
"supportedProfile": [
"http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Organization"
],
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"Organization:endpoint",
"Organization:partof"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "identifier",
"type": "token",
"documentation": "Any identifier for the organization (not the accreditation issuer's identifier)"
},
{
"name": "partof",
"type": "reference",
"documentation": "An organization of which this organization forms a part"
},
{
"name": "address",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
},
{
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "active",
"type": "token",
"documentation": "Is the Organization record active"
},
{
"name": "type",
"type": "token",
"documentation": "A code for the type of organization"
},
{
"name": "address-postalcode",
"type": "string",
"documentation": "A postal code specified in an address"
},
{
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "endpoint",
"type": "reference",
"documentation": "Technical endpoints providing access to services operated for the organization"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of the organization's name using some kind of phonetic matching algorithm"
},
{
"name": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of the organization's name or alias"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "Patient",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient",
"supportedProfile": [
"http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient"
],
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"Patient:general-practitioner",
"Patient:link",
"Patient:organization"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "birthdate",
"type": "date",
"documentation": "The patient's date of birth"
},
{
"name": "deceased",
"type": "token",
"documentation": "This patient has been marked as deceased, or as a death date entered"
},
{
"name": "address-state",
"type": "string",
"documentation": "A state specified in an address"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the patient"
},
{
"name": "link",
"type": "reference",
"documentation": "All patients linked to the given patient"
},
{
"name": "language",
"type": "token",
"documentation": "Language code (irrespective of use value)"
},
{
"name": "address-country",
"type": "string",
"documentation": "A country specified in an address"
},
{
"name": "death-date",
"type": "date",
"documentation": "The date of death has been provided and satisfies this search value"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm"
},
{
"name": "telecom",
"type": "token",
"documentation": "The value in any kind of telecom details of the patient"
},
{
"name": "address-city",
"type": "string",
"documentation": "A city specified in an address"
},
{
"name": "email",
"type": "token",
"documentation": "A value in an email contact"
},
{
"name": "given",
"type": "string",
"documentation": "A portion of the given name of the patient"
},
{
"name": "identifier",
"type": "token",
"documentation": "A patient identifier"
},
{
"name": "address",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
},
{
"name": "general-practitioner",
"type": "reference",
"documentation": "Patient's nominated general practitioner, not the organization that manages the record"
},
{
"name": "active",
"type": "token",
"documentation": "Whether the patient record is active"
},
{
"name": "address-postalcode",
"type": "string",
"documentation": "A postalCode specified in an address"
},
{
"name": "phone",
"type": "token",
"documentation": "A value in a phone contact"
},
{
"name": "organization",
"type": "reference",
"documentation": "The organization that is the custodian of the patient record"
},
{
"name": "address-use",
"type": "token",
"documentation": "A use code specified in an address"
},
{
"name": "name",
"type": "string",
"documentation": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "family",
"type": "string",
"documentation": "A portion of the family name of the patient"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "SearchParameter",
"profile": "http://hl7.org/fhir/StructureDefinition/SearchParameter",
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"SearchParameter:component",
"SearchParameter:derived-from"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The search parameter publication date"
},
{
"name": "code",
"type": "token",
"documentation": "Code used in URL"
},
{
"name": "context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the search parameter"
},
{
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the search parameter"
},
{
"name": "derived-from",
"type": "reference",
"documentation": "Original definition for the search parameter"
},
{
"name": "description",
"type": "string",
"documentation": "The description of the search parameter"
},
{
"name": "context-type",
"type": "token",
"documentation": "A type of use context assigned to the search parameter"
},
{
"name": "type",
"type": "token",
"documentation": "number | date | string | token | reference | composite | quantity | uri | special"
},
{
"name": "version",
"type": "token",
"documentation": "The business version of the search parameter"
},
{
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the search parameter"
},
{
"name": "target",
"type": "token",
"documentation": "Types of resource (if a resource reference)"
},
{
"name": "context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the search parameter"
},
{
"name": "component",
"type": "reference",
"documentation": "Defines how the part works"
},
{
"name": "context",
"type": "token",
"documentation": "A use context assigned to the search parameter"
},
{
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the search parameter"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the search parameter"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the search parameter"
},
{
"name": "base",
"type": "token",
"documentation": "The resource type(s) this search parameter applies to"
},
{
"name": "status",
"type": "token",
"documentation": "The current status of the search parameter"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "StructureDefinition",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition",
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*",
"StructureDefinition:base",
"StructureDefinition:valueset"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The structure definition publication date"
},
{
"name": "context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the structure definition"
},
{
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the structure definition"
},
{
"name": "description",
"type": "string",
"documentation": "The description of the structure definition"
},
{
"name": "context-type",
"type": "token",
"documentation": "A type of use context assigned to the structure definition"
},
{
"name": "experimental",
"type": "token",
"documentation": "For testing purposes, not real usage"
},
{
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the structure definition"
},
{
"name": "type",
"type": "uri",
"documentation": "Type defined or constrained by this structure"
},
{
"name": "context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the structure definition"
},
{
"name": "path",
"type": "token",
"documentation": "A path that is constrained in the StructureDefinition"
},
{
"name": "base-path",
"type": "token",
"documentation": "Path that identifies the base element"
},
{
"name": "context",
"type": "token",
"documentation": "A use context assigned to the structure definition"
},
{
"name": "keyword",
"type": "token",
"documentation": "A code for the StructureDefinition"
},
{
"name": "context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the structure definition"
},
{
"name": "identifier",
"type": "token",
"documentation": "External identifier for the structure definition"
},
{
"name": "valueset",
"type": "reference",
"documentation": "A vocabulary binding reference"
},
{
"name": "kind",
"type": "token",
"documentation": "primitive-type | complex-type | resource | logical"
},
{
"name": "abstract",
"type": "token",
"documentation": "Whether the structure is abstract"
},
{
"name": "version",
"type": "token",
"documentation": "The business version of the structure definition"
},
{
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the structure definition"
},
{
"name": "ext-context",
"type": "token",
"documentation": "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text"
},
{
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the structure definition"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the structure definition"
},
{
"name": "derivation",
"type": "token",
"documentation": "specialization | constraint - How relates to base definition"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "base",
"type": "reference",
"documentation": "Definition that this type is constrained/specialized from"
},
{
"name": "status",
"type": "token",
"documentation": "The current status of the structure definition"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
},
{
"type": "ValueSet",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet",
"interaction": [
{
"code": "history-instance"
},
{
"code": "history-type"
},
{
"code": "read"
},
{
"code": "search-type"
},
{
"code": "vread"
}
],
"versioning": "versioned-update",
"conditionalCreate": true,
"conditionalUpdate": true,
"conditionalDelete": "single",
"referencePolicy": [
"resolves"
],
"searchInclude": [
"*"
],
"searchParam": [
{
"name": "_language",
"type": "string",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The value set publication date"
},
{
"name": "identifier",
"type": "token",
"documentation": "External identifier for the value set"
},
{
"name": "code",
"type": "token",
"documentation": "This special parameter searches for codes in the value set. See additional notes on the ValueSet resource"
},
{
"name": "context-type-value",
"type": "composite",
"documentation": "A use context type and value assigned to the value set"
},
{
"name": "jurisdiction",
"type": "token",
"documentation": "Intended jurisdiction for the value set"
},
{
"name": "description",
"type": "string",
"documentation": "The description of the value set"
},
{
"name": "context-type",
"type": "token",
"documentation": "A type of use context assigned to the value set"
},
{
"name": "title",
"type": "string",
"documentation": "The human-friendly name of the value set"
},
{
"name": "version",
"type": "token",
"documentation": "The business version of the value set"
},
{
"name": "url",
"type": "uri",
"documentation": "The uri that identifies the value set"
},
{
"name": "expansion",
"type": "uri",
"documentation": "Identifies the value set expansion (business identifier)"
},
{
"name": "reference",
"type": "uri",
"documentation": "A code system included or excluded in the value set or an imported value set"
},
{
"name": "context-quantity",
"type": "quantity",
"documentation": "A quantity- or range-valued use context assigned to the value set"
},
{
"name": "context",
"type": "token",
"documentation": "A use context assigned to the value set"
},
{
"name": "name",
"type": "string",
"documentation": "Computationally friendly name of the value set"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the value set"
},
{
"name": "_id",
"type": "token",
"documentation": "The ID of the resource"
},
{
"name": "context-type-quantity",
"type": "composite",
"documentation": "A use context type and quantity- or range-based value assigned to the value set"
},
{
"name": "status",
"type": "token",
"documentation": "The current status of the value set"
},
{
"name": "_lastUpdated",
"type": "date",
"documentation": "Select resources based on the last time they were changed"
}
]
}
],
"interaction": [
{
"code": "history-system"
},
{
"code": "transaction"
}
]
}
]
}The Well Known statement is also available at `[base]/.well-known/smart-configuration`:
GET [base]/.well-known/smart-configuration
Click to expand JSON snippet
{
"response_types_supported": [
"code",
"refresh_token"
],
"capabilities": [
"launch-standalone",
"client-confidential-symmetric",
"context-standalone-patient",
"permission-patient",
"permission-user"
],
"introspection_endpoint": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/oauth/introspect",
"registration_endpoint": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/oauth/register/client",
"token_endpoint_auth_methods_supported": [
"client_secret_basic"
],
"scopes_supported": [
"patient/*.read",
"user/*.read",
"offline_access",
"launch/patient",
"openid",
"fhirUser"
],
"authorization_endpoint": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/oauth/authorization",
"token_endpoint": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/oauth/token"
}The server supports reading the list of health plans provided by a payer and the medication and costs for each plan through unauthenticated access.
Check the provided postman collection for anticipated queries.
As mentioned above, the authenticated access follows the SMART on FHIR App Launch Framework "standalone launch" workflow.
Check the Getting Started page for authorization and authentication request examples.
Note: the user must be authenticated.
The user's drug coverage can be queried by calling the coverage endpoint /Coverage with the patient and coverage type parameters. Drug coverage can be searched for with a coverage.type of http://terminology.hl7.org/CodeSystem/v3-ActCode|DRUGPOL. The patient id provided in the request must match the logged in user's patient id.
Sample request:
GET HTTP/1.1
Authorization: Bearer {your access token}
Content-Type: application/json
[base]/Coverage?
patient={logged in user's patient id}
&type=http://terminology.hl7.org/CodeSystem/v3-ActCode|DRUGPOL
This will return a Bundle containing the user's drug coverage.
Click to expand Response JSON snippet
{
"resourceType": "Bundle",
"id": "b5fcd9e1-4ea8-4121-85a3-01008ae983e9",
"meta": {
"lastUpdated": "2022-05-02T20:19:12.865+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "http://localhost:8080/fhir/Coverage?_include=Coverage%3Apatient&patient=PDexPatient&type=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv3-ActCode%7CDRUGPOL"
}
],
"entry": [
{
"fullUrl": "http://localhost:8080/fhir/Coverage/Coverage1",
"resource": {
"resourceType": "Coverage",
"id": "Coverage1",
"meta": {
"versionId": "1",
"lastUpdated": "2022-03-11T17:51:08.908+00:00",
"source": "#CZTwaw8q8stUadle",
"profile": [
"http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Coverage|1.2.0"
]
},
"language": "en-US",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource "Coverage1" Updated "2020-07-07T13:26:22.031Z" (Language "en-US") </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-C4BB-Coverage.html\">C4BB Coverage (version 1.2.0)</a></p></div><p><b>identifier</b>: Member Number: 1234-234-1243-12345678901</p><p><b>status</b>: active</p><p><b>type</b>: drug policy <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/2.1.0/CodeSystem-v3-ActCode.html\">ActCode</a>#DRUGPOL)</span></p><p><b>policyHolder</b>: <a href=\"Patient-PDexPatient.html\">Patient/PDexPatient</a> " EXAMPLE1"</p><p><b>subscriber</b>: <a href=\"Patient-PDexPatient.html\">Patient/PDexPatient</a> " EXAMPLE1"</p><p><b>subscriberId</b>: 12345678901</p><p><b>beneficiary</b>: <a href=\"Patient-PDexPatient.html\">Patient/PDexPatient</a> " EXAMPLE1"</p><p><b>dependent</b>: 01</p><p><b>relationship</b>: Self <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/2.1.0/CodeSystem-subscriber-relationship.html\">SubscriberPolicyholder Relationship Codes</a>#self)</span></p><p><b>period</b>: 2021-01-01 --> 2021-12-31</p><p><b>payor</b>: <a href=\"Organization-Payer1.html\">Organization/Payer1</a> "Payer 1"</p><blockquote><p><b>class</b></p><p><b>type</b>: An employee group <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/2.1.0/CodeSystem-coverage-class.html\">Coverage Class Codes</a>#group)</span></p><p><b>value</b>: 021890</p><p><b>name</b>: Acme Corporation</p></blockquote><blockquote><p><b>class</b></p><p><b>type</b>: Plan <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/2.1.0/CodeSystem-coverage-class.html\">Coverage Class Codes</a>#plan)</span></p><p><b>value</b>: XYZ123</p><p><b>name</b>: XYZ123-UPMC CONSUMER ADVA</p></blockquote><p><b>network</b>: XYZ123-UPMC CONSUMER ADVA</p></div>"
},
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MB"
}
]
},
"system": "https://www.xxxhealthplan.com/fhir/memberidentifier",
"value": "1234-234-1243-12345678901"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "DRUGPOL",
"display": "drug policy"
}
],
"text": "drug policy"
},
"policyHolder": {
"reference": "Patient/PDexPatient"
},
"subscriber": {
"reference": "Patient/PDexPatient"
},
"subscriberId": "12345678901",
"beneficiary": {
"reference": "Patient/PDexPatient"
},
"dependent": "01",
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
"code": "self"
}
]
},
"period": {
"start": "2021-01-01",
"end": "2021-12-31"
},
"payor": [
{
"reference": "Organization/Payer1"
}
],
"class": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "group"
}
],
"text": "An employee group"
},
"value": "021890",
"name": "Acme Corporation"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "plan"
}
],
"text": "Plan"
},
"value": "Formulary-10207VA0380001",
"name": "BlueChoice HMO Silver $3,500"
}
],
"network": "BlueChoice HMO Silver $3,500"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "http://localhost:8080/fhir/Patient/PDexPatient",
"resource": {
"resourceType": "Patient",
"id": "PDexPatient",
"meta": {
"versionId": "1",
"lastUpdated": "2022-03-11T17:50:05.911+00:00",
"source": "#LatbnDbjinLYYhJo",
"profile": [
"http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient|1.2.0"
]
},
"language": "en-US",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource "PDexPatient" Updated "2020-07-07T13:26:22.031Z" (Language "en-US") </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-C4BB-Patient.html\">C4BB Patient (version 1.2.0)</a></p></div><p><b>identifier</b>: Member Number: 1234-234-1243-12345678901, Unique Member ID: 1234-234-1243-12345678901u</p><p><b>active</b>: true</p><p><b>name</b>: Johnny Example1 </p><p><b>telecom</b>: ph: (301)666-1212</p><p><b>gender</b>: male</p><p><b>birthDate</b>: 1986-01-01</p><p><b>address</b>: 123 Main Street Pittsburgh PA 12519 </p><p><b>maritalStatus</b>: unknown <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/2.1.0/CodeSystem-v3-NullFlavor.html\">NullFlavor</a>#UNK)</span></p></div>"
},
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MB"
}
]
},
"system": "https://www.xxxhealthplan.com/fhir/memberidentifier",
"value": "1234-234-1243-12345678901"
},
{
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/us/carin-bb/CodeSystem/C4BBIdentifierType",
"code": "um"
}
]
},
"system": "https://www.xxxhealthplan.com/fhir/iniquememberidentifier",
"value": "1234-234-1243-12345678901u"
}
],
"active": true,
"name": [
{
"family": "Example1",
"given": [
"Johnny"
]
}
],
"telecom": [
{
"system": "phone",
"value": "(301)666-1212",
"rank": 2
}
],
"gender": "male",
"birthDate": "1986-01-01",
"address": [
{
"type": "physical",
"line": [
"123 Main Street"
],
"city": "Pittsburgh",
"state": "PA",
"postalCode": "12519"
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "UNK"
}
]
}
},
"search": {
"mode": "include"
}
}
]
}Once the drug coverage resource is retrieved, the Formulary plan identifier can be queried from the corresponding Coverage.class.value.
Coverage Resource Snippet:
"class": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "plan"
}
]
},
"value": "Formulary-10207VA0380001",
"name": "BlueChoice HMO Silver $3,500"
}
]With the Formulary identifier retrieved, the user's formulary can be queried as follow:
Note: access token is not required to query the
/InsurancePlanendpoint.
GET [base]/InsurancePlan?
type=http://terminology.hl7.org/CodeSystem/v3-ActCode|DRUGPOL
&identifier=Formulary-10207VA0380001
Click to expand response JSON snippet
{
"resourceType": "Bundle",
"id": "5afb718d-f15f-4d62-babe-8800ca8a4792",
"meta": {
"lastUpdated": "2022-05-02T20:37:57.276+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "http://localhost:8080/fhir/InsurancePlan?identifier=Formulary-10207VA0380001&type=http%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fv3-ActCode%7CDRUGPOL"
}
],
"entry": [
{
"fullUrl": "http://localhost:8080/fhir/InsurancePlan/Formulary-10207VA0380001",
"resource": {
"resourceType": "InsurancePlan",
"id": "Formulary-10207VA0380001",
"meta": {
"versionId": "1",
"lastUpdated": "2021-10-22T23:37:44.157+00:00",
"source": "#nqBI6U4SeYUmkMjn",
"profile": [
"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-Formulary"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">BlueChoice HMO Silver $3,500</div>"
},
"identifier": [
{
"value": "Formulary-10207VA0380001"
}
],
"status": "active",
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "DRUGPOL",
"display": "drug policy"
}
]
}
],
"name": "BlueChoice HMO Silver $3,500"
},
"search": {
"mode": "match"
}
}
]
}This server supports exporting Formularies data in bulk according to the Bulk Data IG. Instead of making individual requests to gather data, the bulk data export supports exporting all available formularies data not related to a patient at once.
The bulk data export request flow includes a kick-off request, status request, and file requests. Check the Bulk Data specification for more details.
| Service | Method | Description |
|---|---|---|
/InsurancePlan/$export |
GET |
Request to export all InsurancePlan, Basic, MedicationKnowledge, and Location resource types containing formulary related data associated with all formulary related plans. |
/InsurancePlan/[:id]/$export |
GET |
Resquest to export all InsurancePlan, Basic, MedicationKnowledge, and Location resource types containing formulary related data associated with the specific plan. |
|
The $export operation can be applied to request all InsurancePlan data (GET [base]/InsurancePlan/$export) or specific InsurancePlan data (/InsurancePlan/[:id]/$export).
SUCCESS RESPONSE
-
202 Acceptedstatus - The Content-Location header containing a URL which can be used to request the status of the bulk data export.
RESPONSE on Error
-
400 Bad Requeststatus - The body of the response will include a FHIR OperationOutcome with an error message indicating the issue.
After a bulk data request has successfully started, the client can send a GET request to the polling URL returned in the Content-Location header of the response to the kick-off request.
RESPONSE
-
200 OKstatus - The body of the response will follow the JSON format described in section 5.3.4 of the bulk data access specification.
Click to expand JSON response body
{
"transactionTime": "2022-04-28T14:26:51-04:00",
"request": "https://davinci-drug-formulary-ri.logicahealth.org/fhir/InsurancePlan/PayerInsurancePlanA3001/$export",
"requiresAccessToken": false,
"output": [
{
"type": "InsurancePlan",
"url": "https://davinci-drug-formulary-ri.logicahealth.org/resources/PayerInsurancePlanA3001/InsurancePlan.ndjson"
},
{
"type": "Basic",
"url": "https://davinci-drug-formulary-ri.logicahealth.org/resources/PayerInsurancePlanA3001/Basic.ndjson"
},
{
"type": "MedicationKnowledge",
"url": "https://davinci-drug-formulary-ri.logicahealth.org/resources/PayerInsurancePlanA3001/MedicationKnowledge.ndjson"
},
{
"type": "Location",
"url": "https://davinci-drug-formulary-ri.logicahealth.org/resources/PayerInsurancePlanA3001/Location.ndjson"
}
]
}The url values listed on each element of the output array can be used to access the generated exports.
Once the export operation is complete, the client can send a get request to any of the URLs retrieved from the response of the status request.
Success Response
-
200 OKstatus - The response body will include the requested resources as a newline delimited JSON file (ndjson).
Click to expand ndjson returned file
{"id":"PayerPlan-10207VA0380003","meta":{"lastUpdated":"2017-10-25","profile":["http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-PayerInsurancePlan"]},"text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">HealthyBlue HMO</div>"},"extension":[{"url":"http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-DrugPlanReference-extension","valueReference":{"reference":"InsurancePlan/Drug-10207VA0380003","type":"InsurancePlan"}}],"identifier":[{"value":"Payer-10207VA0380003"}],"status":"active","type":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-pdex-plan-net/CodeSystem/InsuranceProductTypeCS","code":"commhmo","display":"Medicare Advantage"}]}],"name":"HealthyBlue HMO","contact":[{"purpose":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/contactentity-type","code":"PATINF","display":"Patient"}]},"telecom":[{"system":"email","value":"Patrick.Breen@carefirst.com"}]}],"resourceType":"InsurancePlan"}
{"id":"DrugPlan-10207VA0380003","meta":{"lastUpdated":"2017-10-25","profile":["http://hl7.org/fhir/us/davinci-drug-formulary/StructureDefinition/usdf-InsuranceDrugPlan"]},"text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">HealthyBlue HMO Gold $1,000</div>"},"identifier":[{"value":"Drug-10207VA0380003"}],"status":"active","type":[{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-ActCode","code":"DRUGPOL","display":"drug policy"}]}],"name":"HealthyBlue HMO Gold $1,000","contact":[{"purpose":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/contactentity-type","code":"PATINF","display":"Patient"}]},"telecom":[{"system":"url","value":"https://content.carefirst.com/sbc/$0/ D,$50/ D,$70/ D,$100/ D,$+"},{"system":"email","value":"Patrick.Breen@carefirst.com"}]}],"plan":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-PharmacyTypeCS","code":"1-month-in-retail","display":"1 month in network retail"}]},"network":[{"display":"PREFERRED"}],"specificCost":[{"category":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS","code":"zero-cost-share-preventative","display":"Zero cost-share preventative"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0,"system":"http://unitsofmeasure.org","code":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS","code":"non-preferred-brand","display":"Non-preferred Brand"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":70.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":70.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":140.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":140.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS","code":"specialty","display":"Specialty"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":100.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":100.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":200.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":200.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS","code":"preferred-brand","display":"Preferred Brand"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":50.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":50.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":100.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":100.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS","code":"generic","display":"Generic"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":150.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":150.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":300.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":300.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"after-deductible","display":"After Deductible"}]}],"value":{"value":1.0,"system":"http://unitsofmeasure.org","code":"%"}}]}]},{"category":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-DrugTierCS","code":"generic","display":"Generic"}]},"benefit":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0,"system":"http://unitsofmeasure.org","code":"%"}}]},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitTypeCS","code":"drug","display":"Drug"}]},"cost":[{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"copay"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CopayOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0}},{"type":{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-BenefitCostTypeCS","code":"coinsurance"}]},"qualifiers":[{"coding":[{"system":"http://hl7.org/fhir/us/davinci-drug-formulary/CodeSystem/usdf-CoinsuranceOptionCS","code":"no-charge","display":"No Charge"}]}],"value":{"value":0.0,"system":"http://unitsofmeasure.org","code":"%"}}]}]}]}],"resourceType":"InsurancePlan"}Response on Error
The response will have a 404 Not Found status, indicating that the file does not exist.