Mode SERVER Description Transaction System History System Search Resource Type Profile Read Search Update Create AllergyIntolerance y y y Appointment y y Binary y Condition y y y Consent y y Coverage y y Device y y DeviceRequest y y DeviceUseStatement y y DiagnosticReport y y DocumentReference y y y Encounter y y Endpoint y Flag y y Goal y y y Immunization y y ImmunizationRecommendation y y List y y Location y Medication y MedicationDispense y y MedicationRequest y y MedicationStatement y y NutritionOrder y y Observation y y y y Organization y Patient y y y Practitioner y y PractitionerRole y y Procedure y y ProcedureRequest y y Schedule y Slot y Specimen y y
Search for AllergyIntolerance resources for a specified patient ID.
FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.
Refine a search for Appointment resources by date. By default, all Appointments are returned.
Refine a search for Appointment resources by identifier.
Search for Appointment resources for a specified patient ID.
Refine a search for Appointment resources by status. By default, all Appointments are returned.
Refine a search for Condition resources by category. By default, the search returns problem list Condition resources.
Refine a search for Condition resources by clinicalStatus. By default, the search returns active Condition resources. Only clinical statuses of resolved and active are supported.
Search for Condition resources for specific encounters. If not provided, only problem list Condition results are returned.
Search for Condition resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Refine a search for Consent resources by category.
Search for Consent resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Refine a search for Consent resources by status.
Search for Coverage resource for a specific patient ID. You can use "patient" or "beneficiary" equivalently, but they cannot be used at the same time for different references.
A string that will match the Device.udi.name field. Not case sensitive.
The patient in whom this device is implanted. This is a required parameter.
The UDI barcode string - matches static UDI.
Search for a DeviceRequest resource for a specified patient ID.
Search for a DeviceRequest based on a device request status
Search for DeviceUseStatement resources for a specified patient ID.
Refine a search for DiagnosticReport resources by category.
Refine a search for DiagnosticReport resources by code.
Refine a search for DiagnosticReport resources by specifying a date or date range that a DiagnosticReport was resulted or recorded. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. Not supported by Care Plan Goal.
Search for DiagnosticReport resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Further refine a search for a given set of DocumentReferences on a patient by specifying a Practitioner ID that corresponds to the author of the document. Not supported for ccda-document or clinical-note search.
Refine a search for DocumentReference resources by category. Only "clinical-note", "ccda-document", "correspondence", and "imaging-result" are supported.
Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD]]) that corresponds to the document creation time. Not supported for correspondence or imaging-result search.
Further refine a search for a given set of DocumentReferences on a patient by specifying a docStatus. By default, all docStatuses are returned. Not supported for ccda-document, correspondence, or imaging-result search.
Search for DocumentReference resources for a specified encounter ID. Not supported for ccda-document, correspondence, or imaging-result search.
Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD]]) that corresponds to the document indexed time. Not supported for ccda-document or clinical-note search.
Search for DocumentReference resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD]]) that corresponds to the time of the service that is being documented.
Further refine a search for a given set of DocumentReferences on a patient by specifying a LOINC code or internal category ID to return only documents of that type. Not supported for ccda-document search.
Refine a search for Encounter resources by class. By default, all classes are returned.
Refine a search for Encounter resources by date. By default, all Encounters are returned. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]). Local server time is assumed if time zone information is not included.
Search for Encounter resources by encounter identifier in the format |
Search for Encounter resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references.
Refine a search for Flag resources by category.
Search for Flag resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Refine a search for Flag resources by status.
Refines a search by Goal Category. This parameter is ignored if searching via _ID.
Search for Patient resources for a specific patient ID. You can use "patient" or "subject" equivalently but they can't be used at the same time for different references. This parameter is ignored if searching via _ID.
Refines a search based on Goal Status. This parameter is ignored if searching via _ID. This parameter is only supported by patient goals.
Vaccine administration date. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. This parameter is ignored if searching via ids.
A boolean that indicates whether or not an immunization has been administered. This parameter is ignored if searching via ids.
Search for Immunization resources for a specified patient ID. This parameter is ignored if searching via ids.
Refine a search for Immunization by status. Completed is the only supported status.
The FHIR id of a patient whose immunization recommendations you'd like to obtain. Only one of either patient or subject needs to be specified.
The kind of list to search for (e.g. PatientList)
Used to return patients that have questionnaires due by a certain date.
An internal id and system allowing access to a list without knowing its FHIR ID (currently supports Patient Lists).
Search for MedicationDispense resources for a specified patient ID.
Search for MedicationDispense resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references.
Further refine a search for MedicationRequest resources for a given patient by specifying a date or a range of dates for when the medication was ordered. Note: all medications will be returned regardless of date range provided on the search.
Refine a search for MedicationRequest resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, and community are supported.
Search for MedicationRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references.
Refine a search for MedicationRequest resources by one or more statuses. By default, only medications with active statuses are returned. MedicationRequest searches support active, on-hold, completed and stopped. If searching by status, active must be included.
Search for MedicationRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Refine a search for MedicationStatement resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, and patientspecified are supported.
Further refine a search for MedicationStatement resources for a given patient by specifying a date or a range of dates for when the medication was ordered. Note: all medications will be returned regardless of date range provided on the search.
Search for MedicationStatement resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for difference references.
Refine a search for MedicationStatement resources by one or more statuses. By default, only medications with active statuses are returned. MedicationStatement searches support active, on-hold, completed, and stopped. If searching by status, active must be included.
Search for MedicationStatement resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Search for NutritionOrder resources for a specified patient ID.
Refine a search for Observation resources by category. Only laboratory, vital-signs, social-history, core-characteristics, functional-mental-status, LDA, and SNOMED codes 384821006 and 118228005 are supported.
Refine a search for Observation resources by LOINC code, SNOMED code, or flowsheet row IDs.
Refine a search for Observation resources by specifying a date or date range that a result- or vital sign-based Observation was resulted or recorded. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.
Refine a search for Observation resources by specifying a date or date range that a social-history-based Observation was made available. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.
Search for Observation resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Search for Patient resources using an address string.
Search for Patient resources using the city for a patient's home address. You can use this parameter along with other address parameters.
Search for Patient resources using the postal code for a patient's home address. You can use this parameter along with other address parameters.
Search for Patient resources using the state for a patient's home address. You can use this parameter along with other address parameters.
Search for Patient resources using a date of birth in ISO format (YYYY-MM-DD).
Search for Patient resources by family (last) name. You can use the family parameter along with other name parameters to search by a patient's name. Family name searching supports exact matching, "sounds like" matching, and patient aliases.
Search for Patient resources using the following gender codes: female, male, other, or unknown.
Search for Patient resources by given (first) name. You can use the given parameter along with other name parameters to search by a patient's name. Given name searching supports both exact and "sounds like" matches. Patient aliases and dominant name aliases (ex. Bob for Robert) are also supported.
Search for Patient resources by a patient's identifier. You can use the identifier parameter as the only parameter in a search or in conjunction with other parameters. A patient's identifier must be in the format {|} or {<ID Type>|}<ID>.
Search for Patient resources using the following gender codes: female, male, nonbinary, x, other, or unknown.
Search for Patient resources by a patient's name. To search on specific name parts use the name part parameters, such as family or given. This parameter is ignored if any name part parameters are used.
Search for Patient resources by patient's own last name, usually used in non-US names. You can use the own-name parameter along with other name parameters to search by a patient's name.
Search for Patient resources by patient's own last name prefix, usually used in non-US names. You can use the own-prefix parameter along with other name parameters to search by a patient's name, but own-name must also be included.
Search for Patient resources by patient's spouse's last name, usually used in non-US names. You can use the partner-name parameter along with other name parameters to search by a patient's name, but own-name must also be included.
Search for Patient resources by patient's spouse's last name prefix, usually used in non-US names. You can use the partner-prefix parameter along with other name parameters to search by a patient's name, but own-name must also be included.
Search for Patient resources using a patient's home phone number, cell phone number, or email address.
Any part of an address (street, city, etc.) where a practitioner can be visited. When used, family is also required. Only respected if no other address parameters are populated. Only the first instance of this parameter is respected.
The city where a practitioner can be visited. When used, address-state is also required. Only the first instance of this parameter is respected.
The zip code where a practitioner can be found. When used, family is also required.
The state where a practitioner can be found. When used, family is also required. Only the first instance of this parameter is respected.
A practitioner's family (last) name. Only the first instance of this parameter is respected.
A practitioner's given (first) name. When used, family is also required. Only the first instance of this parameter is respected.
A practitioner's identifier in the format |. Code system must be a URN. When this parameter is provided, all others (except _id) are ignored.
Any part of a practitioner's name. For full names, format should be first last. When specified, family and given are ignored. Only the first instance of this parameter is respected.
Refine a search for a PractitionerRole by entering a valid email address. Code system is ignored.
Search for PractitionerRoles using identifiers. A code system is required. The code must be prepended with URN:OID. Some codes may need to be URL encoded prior to query.
Search for PractitionerRoles using a Location ID. Only the first instance of this parameter is respected.
Search for PractitionerRoles using an Organization ID. Only the first instance of this parameter is respected.
Refine a search for a PractitionerRole by entering a valid phone number. Code system is ignored.
Search for PractitionerRoles for a specified Practitioner ID. Only the first instance of this parameter is respected.
Refine a search for a PractitionerRole by entering a valid role. System must be included.
Search for PractitionerRoles for a given specialty. A code system is required. Depending on the organization, NUCC may be supported.
Refine a search for a PractitionerRole for a specific telecom. System must be specified as either 'phone' or 'email'
Refine a search for Procedure resources by category. Only the following values are supported: 103693007 (diagnostic procedures), 387713003 (surgical procedures), 9632001 (nursing procedures, Netherlands only), and 225317005 or freedom-restricting-intervention (restricting intervention, Netherlands only) are supported.
Refine a search for Procedure resources by specifying a date or date range that a Procedure was resulted. Enter dates in ISO format (YYYY[-MM[-DD]]). Not supported by nursing procedures or restricting interventions.
Search for Procedure resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Search for ProcedureRequest resources for specific encounters. If not provided, all ProcedureRequest results are returned.
Search for ProcedureRequest resources for a specified patient ID. You can use "patient" or "subject" equivalently, but they cannot be used at the same time for different references.
Refine a search for ProcedureRequest resources by individual making the request. By defualt, all ProcedureRequests are returned.
Refine a search for ProcedureRequest resources by status. By default, only active ProcedureRequests are returned. Statuses of draft, active, completed, cancelled, and unknown are supported.