Basic FHIR resources with the most commonly-used operations and
search examples
Note – Base URL in the below API requests is just an example and needs to be specific to your
ENVIRONMENT. In addition, the FHIR ID used in various GET requests are just used as reference and
should be changed specific to the data set.
Base URL: [Link]
Capability Statement:
[Link]
Patient Access API
Patient details:
[Link]
Patient Coverage and EOB details:
[Link]
evinclude=ExplanationOfBenefit:patient
Patient Encounter details:
[Link]
Observation:
[Link]
Patient Procedures:
[Link]
Patient Observation:
[Link]
Code of the observation type:
[Link]
Patient Condition:
[Link]
Clinical Status:
[Link]
Basic FHIR resources with the most commonly-used operations and
search examples
Provider Directory:
All Plans
[Link]
formulary/StructureDefinition/usdf-CoveragePlan
Plan details for a practitioner
[Link]
Lookup by name:
[Link]
e=PractitionerRole:practitioner&_include=PractitionerRole:service
what insurance plan does a plan accept?
[Link]
s/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug&DrugPlan=12345XX9876543-
2020&DrugTier=generic
find female practitioner who speaks Spanish?
[Link]
[Link]=es&_include=PractitionerRole:practitioner&_include=PractitionerRole:service
Find ophthalmology service in my area:
[Link]
[Link]=72201&_include=PractitionerRole:practitioner&_include=PractitionerRole:service
In-network practitioners for a selected insurance plan
[Link]
er&[Link]=Vandelay Insurance Gold Health Plan
find male practitioners near me who provide ophthalmology service and accept my insurance plan
[Link]
postalcode=72201&[Link]=female&[Link]=Opthalmology&_include=Practitioner
Role:practitioner&_include=PractitionerRole:service&_include=PractitionerRole:organization&_includ
e=PractitionerRole:endpoint
Look up by NPI:
[Link]
_include=PractitionerRole:practitioner&_include=PractitionerRole:service
Basic FHIR resources with the most commonly-used operations and
search examples
Drug Formulary:
All formulary drug in a coverage plan:
[Link]
s/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug&DrugPlan=12345XX9876543
Find Coverage by Plan ID
[Link]
formulary/StructureDefinition/usdf-CoveragePlan&_id=886
Find all drugs in a specific tier of a coverage plan
[Link]
s/davinci-drug-formulary/StructureDefinition/usdf-FormularyDrug&DrugPlan=12345XX9876543-
2020&DrugTier=generic
Find drug by code in a coverage plan:
[Link]
s/davinci-drug-formulary/StructureDefinition/usdf-
FormularyDrug&DrugPlan=12345XX9876543&code=209459
Lookup by Organization Name:
[Link]
Hospital&_include=HealthcareService:organization
Lookup by zip
[Link]
postalcode=98004&_include=HealthcareService:organization
Lookup by provided services
[Link]
nization
Lookup organizations of particular insurance plan
[Link] Insurance Premium
Health Plan&_include=PractitionerRole:organization
Lookup organizations of particular payer
[Link]
zation&_include=HealthcareService:location
Lookup organizations of my patient’s insurance plan
Basic FHIR resources with the most commonly-used operations and
search examples
[Link]
ation
What locations provide specialty services for my local hospital network
[Link] Medicine&insurance-
[Link]=Amerigroup Insurance Premium Health
Plan&_include=HealthcareService:organization&_include=HealthcareService:location
Find organizations that provide hospital service and accept my insurance plan
[Link]
reService:organization&_include=HealthcareService:location