HTTP Request Headers
The FHIR® panel and prescription notifications delivered to the Surescripts service must include the HTTP request headers.
Content Type Codes and Encodings
Please be aware that the only valid Accept content type is application/json+fhir, where application/json+fhir is used as the default value.
Although other content types listed here are supported, the application will only return content that maps to application/json+fhir.
Supported content types:
- application/json+fhir (default value)
- application/fhir+json
- application/json
- text/json
HTTP Request Header Elements
Code | Field | Comment |
|---|---|---|
Accept | optional | The Accept request-header field can be used to specify certain media types which are acceptable for the response Values: application/fhir+json |
Content-Type | optional | The Content-Type header is to specify the media type of the content being sent. For more information see the Content Types and Encodings section below. Values: application/fhir+json |
X-SENDER-UID | mandatory | Participant ID Example: T00000000012345 |
X-SENDER-UID-QUALIFIER | mandatory | Participant ID Qualifier Fixed: 10 |
X-Requester-ID | conditional | This will be included in the HTTP Header Request of the FHIR response and identifies the Bundle ID. |
Accept: application/fhir+json
Content-Type: application/fhir+json; charset=UTF-8
X-SENDER-UID: T00000000012345
X-SENDER-UID-QUALIFIER:10FHIR Request Parameters
This section outlines common FHIR parameters that customers may use in their requests. To view the full capabilities of Surescripts Medication History for Populations, retrieve the CapabilityStatement resource from the FHIR API.
Note: See the Messages OverviewMessages Overview section for details on how search requests are processed on the back end of your organization’s system.
Parameter | Requirement | Description | Example |
|---|---|---|---|
_lastUpdated | optional | Indicates the date time of search request. Use gt to indicate greater than and lt for less than to define the loopback window of the request. Format must be YYYY-MM-ddTHH🇲🇲ssZ (in UTC) Note: You may use a smaller lookback window (e.g., last 4 hours or 1 day) when generating panels or notifications. The maximum allowable lookback period is one month from the requested date. |
|
_include | optional | Identifies resource to be returned in your response. include:iterate must be used for resources beyond the 1st resource requested. |
|
_revinclude | optional | Identifies resource to be returned in your response by performing a reverse reference lookup. include:iterate must be used for resources beyond the 1st resource requested. | revinclude=Condition:subject Note: This looks up Condition resources based on the subject (Patient resource). |
_page_token | conditional | Indicates which page of results to retrieve. Defaults to 1 if not provided. Required when additional pages are available. The next page’s token is supplied in Bundle.link. | _page_token= Ad86NARb_Wb3LSoymHxmqiNWoxEs5Lc5MLHnKI48YRUCE58IC2KYqMET |
_count | optional | Size of page that will contain the matches of MedicationDispenses Defaulted to 50 if not populated. Max is 1000. | _count=50 |
[parameter]:missing | optional | The missing modifier used with a parameter will filter FHIR search results include/exclude results don’t have an associated value.
Note: This can be used to exclude patient results where the patient was not found. | based-on:missing=false |