ILLUSTRATIVE CONTENT
Search Parameters
The following search parameters have been defined for the SMART IG. For more information on the FHIR RESTful Search API and the standard see the FHIR specification.
Search Parameters defined by SMART IG
To Update
Search Parameters derived from the Base FHIR Specification
Like US-Core, this Implementation Guide constrains ‘standard’ HL7 search parameters to explicitly declare conformance expectations. These SMART IG SearchParameters are derived from the Base FHIR Specification to define the expectations for the following SearchParameter elements:
- AllergyIntolerance - patient, clinical-status
- Bundle - timestamp, composition
- Composition - patient, type, status, author, date
- Condition - patient, category, clinical-status, code, onset-date
- DiagnosticReport - patient, category, code, date, status
- DocumentReference - _id, patient, category, date, type, status, period
- Immunization - patient, date, status
- MedicationRequest - patient, intent, status, authoredon
- MedicationStatement - patient
- Observation - patient, category, code, date, status
- Patient - _id, identifier, name, birthdate, gender, family
- Practitioner - name, identifier, _id
- PractitionerRole - specialty, practitioner
- Procedure - patient, date
AllergyIntolerence
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
| SHOULD |
patient+clinical-status |
reference+token |
Bundle
| Conformance |
Parameter |
Type |
| SHOULD |
timestamp |
date |
| SHOULD |
composition |
reference |
Composition
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
| SHOULD |
type |
token |
| SHOULD |
status |
token |
| SHOULD |
author |
reference |
| SHOULD |
date |
date |
Condition
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
| SHOULD |
patient+category |
reference+token |
| SHOULD |
patient+clinical-status |
reference+token |
| SHOULD |
patient+code |
reference+token |
| SHOULD |
patient+onset-date |
reference+date |
DiagnosticReport
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
| SHALL |
patient+category |
reference+token |
| SHALL |
patient+code |
reference+token |
| SHALL |
patient+category+date |
reference+token+date |
| SHOULD |
patient+status |
reference+token |
| SHOULD |
patient+code+date |
reference+token+date |
DocumentReference
| Conformance |
Parameter |
Type |
| SHALL |
_id |
token |
| SHALL |
patient |
reference |
| SHALL |
patient+category |
reference+token |
| SHALL |
patient+category+date |
reference+token+date |
| SHALL |
patient+type |
reference+token |
| SHOULD |
patient+status |
reference+token |
| SHOULD |
patient+type+period |
reference+token+date |
Immunization
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
| SHOULD |
patient+date |
reference+date |
| SHOULD |
patient+status |
reference+token |
MedicationRequest
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
| SHOULD |
patient+intent |
reference+token |
| SHOULD |
patient+intent+status |
reference+token+token |
| SHOULD |
patient+intent+authoredon |
reference+token+date |
MedicationStatement
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
Observation
| Conformance |
Parameter |
Type |
| SHALL |
patient+category |
reference+token |
| SHALL |
patient+code |
reference+token |
| SHALL |
patient+category+date |
reference+token+date |
| SHOULD |
patient+category+status |
reference+token+token |
| SHOULD |
patient+code+date |
reference+token+date |
Patient
| Conformance |
Parameter |
Type |
| SHALL |
_id |
token |
| SHALL |
identifier |
token |
| SHOULD |
name |
string |
| SHOULD |
birthdate+name |
date+string |
| SHOULD |
gender+name |
token+string |
| SHOULD |
birthdate+family |
date+string |
| SHOULD |
family+gender |
string+token |
Pracitioner
| Conformance |
Parameter |
Type |
| SHALL |
name |
string |
| SHALL |
identifier |
token |
| SHOULD |
_id |
token |
PractitionerRole
| Conformance |
Parameter |
Type |
| SHALL |
specialty |
token |
| SHALL |
practitioner |
reference |
Procedure
| Conformance |
Parameter |
Type |
| SHALL |
patient |
reference |
| SHALL |
patient+date |
reference+date |
Specification - $everything
URL: [base]/Patient/$everything
URL: [base]/Patient/[id]/$everything
This is an idempotent operation.
FHIR R4 - In Parameters:
| Name |
Cardinality |
Type |
Documentation |
| start |
0..1 |
date |
The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope. |
| end |
0..1 |
date |
The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope. |
| _since |
0..1 |
instant |
Resources updated after this period will be included in the response. The intent of this parameter is to allow a client to request only records that have changed since the last request, based on either the return header time, or or (for asynchronous use), the transaction time. |
| _type |
0..* |
code |
One or more parameters, each containing one or more comma-delimited FHIR resource types to include in the return resources. In the absence of any specified types, the server returns all resource types. |
| _count |
0..1 |
integer |
See discussion below on the utility of paging through the results of the $everything operation |
FHIR R4 - Out Parameters:
| Name |
Cardinality |
Type |
Documentation |
| return |
1..1 |
Bundle |
The bundle type is "searchset". Note: as this is the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as a resource. |
