Search Parameters

These define the properties by which a RESTful FHIR server can be searched. They can also be used for sorting and including related resources in the search results.

Overview

Search interactions are executed as specified in the HL7 FHIR RESTful API search specification. To search for resources using the HTTP GET method, an application will perform the HTTP GET specifying the query parameters associated with the resource in the URL. To search for resources using the HTTP POST method, an application will perform the HTTP POST specifying the query parameters associated with the resource in the request body.

Detailed Definitions


athenahealth Brand

Search by athenahealth Brand (e.g., 'ah-brand=Organization/a-[practiceId].Brand-[brandId]') for resources containing the 'Athena Brand' Extension

Code ah-brand
Url https://fhir.athena.io/SearchParameter/ah-brand
Base DomainResource
Type reference
Target Organization
MultipleOr True
MultipleAnd True
Comparator eq

athenahealth Chart Sharing Group

Search by athenahealth Chart Sharing Group (e.g., 'ah-chart-sharing-group=Organization/a-[practiceId].CSG-[csgId]') for resources containing the 'Athena Chart Sharing Group' Extension

Code ah-chart-sharing-group
Url https://fhir.athena.io/SearchParameter/ah-chart-sharing-group
Base DomainResource
Type reference
Target Organization
MultipleOr True
MultipleAnd True
Comparator eq

athenahealth Cursor

Search by cursor token for first resource to return in a paged search result

Code cursor
Url https://fhir.athena.io/SearchParameter/ah-cursor
Base DomainResource
Type token
MultipleOr False
MultipleAnd False

athenahealth Department

Search by athenahealth Department (e.g., 'ah-department=Organization/a-[practiceId].Department-[deptId]') for resources containing the 'Athena Department' Extension

Code ah-department
Url https://fhir.athena.io/SearchParameter/ah-department
Base DomainResource
Type reference
Target Organization
MultipleOr True
MultipleAnd True
Comparator eq
Modifier type

athenahealth Practice

Identify the athenahealth Practice Organization (e.g., 'ah-practice=Organization/a-1.Practice-[practiceId]')

Code ah-practice
Url https://fhir.athena.io/SearchParameter/ah-practice
Base DomainResource
Type reference
Target Organization
MultipleOr False
MultipleAnd False
Comparator eq

athenahealth Procedure Device

Search for Procedures having a referenced Device

Code device-name
Url https://fhir.athena.io/SearchParameter/ah-procedure-device
Base Procedure
Type reference
Target Device
MultipleOr True

athenahealth Provider Group

Search by athenahealth Provider Group (e.g., 'ah-provider-group=Organization/a-[practiceId].PG-[providerGroupId]') for resources containing the 'Athena Provider Group' Extension

Code ah-provider-group
Url https://fhir.athena.io/SearchParameter/ah-provider-group
Base DomainResource
Type reference
Target Organization
MultipleOr True
MultipleAnd True
Comparator eq
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

On this Page