Documentation Index
Fetch the complete documentation index at: https://mintlify.com/dhanyasukumaran1/fhir_query_validator/llms.txt
Use this file to discover all available pages before exploring further.
FHIR Query Validator validates queries against a built-in registry of HL7 FHIR R4 resource types and their defined search parameters. This page lists all supported resources and their key search parameters. Use the supported_resources list and supported_search_parameters dict to inspect the registry at runtime.
Check supported resources at runtime
from fhir_query_validator import FHIRQueryValidator
validator = FHIRQueryValidator()
# List all supported resource types
print(validator.supported_resources)
# ['Account', 'AllergyIntolerance', 'Appointment', ..., 'ValueSet']
# Get search parameters for a specific resource
patient_params = validator.supported_search_parameters["Patient"]
print(patient_params)
# ['_id', '_lastUpdated', 'active', 'address', 'birthdate', 'death-date', 'deceased',
# 'email', 'family', 'gender', 'given', 'identifier', 'language', 'link', 'name',
# 'organization', 'phone', 'phonetic', 'telecom']
Clinical resources
| Resource | Key search parameters |
|---|
Patient | family, given, name, birthdate, gender, identifier, address, email, phone, deceased |
Observation | code, patient, subject, category, date, status, value-quantity, component-code |
Condition | patient, subject, code, clinical-status, onset-date, recorded-date, severity, category |
Procedure | patient, subject, code, status, date, performer, reason-code |
DiagnosticReport | patient, subject, code, category, date, status, issued, performer |
AllergyIntolerance | patient, code, clinical-status, criticality, date, type, category |
Immunization | patient, date, status, vaccine-code, target-disease, lot-number |
CarePlan | patient, subject, status, category, date, activity-code, care-team |
Goal | patient, subject, lifecycle-status, start-date, target-date, achievement-status |
FamilyMemberHistory | patient, code, date, status, relationship, sex |
Administrative resources
| Resource | Key search parameters |
|---|
Encounter | patient, subject, status, class, date, type, practitioner, location, reason-code |
Appointment | patient, practitioner, location, status, date, service-type, specialty |
Organization | name, identifier, type, address, partof, active, endpoint |
Practitioner | name, family, given, identifier, gender, address, communication |
PractitionerRole | practitioner, organization, role, specialty, location, active |
Location | name, address, type, status, organization, partof |
Coverage | patient, subscriber, beneficiary, status, payor, identifier, type |
Claim | patient, status, use, created, provider, insurer, identifier |
Medication resources
| Resource | Key search parameters |
|---|
MedicationRequest | patient, subject, medication, status, intent, authoredon, requester, code |
MedicationStatement | patient, subject, medication, status, effective, source, code |
Medication | code, identifier, ingredient, manufacturer, status, form |
MedicationDispense | patient, subject, medication, status, whenhandedover, performer, prescription |
MedicationAdministration | patient, subject, medication, status, effective-time, performer, request |
Diagnostic resources
| Resource | Key search parameters |
|---|
ImagingStudy | patient, subject, started, status, modality, series, identifier, reason |
Specimen | patient, subject, type, collected, status, identifier, accession |
Media | patient, subject, type, modality, created, status, operator |
ServiceRequest | patient, subject, code, status, intent, authored, performer, category |
Infrastructure resources
| Resource | Key search parameters |
|---|
Bundle | identifier, type, timestamp, composition |
CapabilityStatement | name, title, status, version, date, url, fhirversion |
OperationOutcome | (no standard search parameters — typically returned in responses, not queried) |
ValueSet | name, title, url, status, version, identifier, code, reference |
CodeSystem | name, title, url, status, version, identifier, code, system |
StructureDefinition | name, title, url, status, type, kind, version, base |
This table lists key search parameters for each resource. The full set of supported parameters — including all FHIR-defined search parameters — is available at runtime via supported_search_parameters["ResourceName"].
Universal search parameters
These parameters are supported on every resource type:
| Parameter | Type | Description |
|---|
_id | token | Filter by resource ID |
_lastUpdated | date | Filter by last modification date |
_tag | token | Filter by resource tag |
_profile | URI | Filter by profile URL |
_security | token | Filter by security label |
_text | string | Full-text search on narrative |
_content | string | Full-text search on resource content |
_filter | special | Advanced filter expression |
_count | number | Limit number of results per page |
_sort | string | Sort results by parameter name |
_include | special | Include referenced resources in results |
_revinclude | special | Include resources that reference this resource |
_summary | token | Return summary representation |
_elements | string | Return only specified elements |
_format | token | Response format (json, xml) |