DocumentReference
GET https://api.flexpa.com/fhir/DocumentReference
DocumentReference is a clinical FHIR Resource for a document of any kind for any purpose, providing metadata about the document so that the document can be discovered and managed. Typically these are clinical notes, often in HTML or free text form, but can be any document type.
While a few payers may make this information available, almost all do not have this data unless it is submitted to the payer by providers for quality measures or other provider/payer data exchange programs, as clinical notes and documentation are not included with or derived from core claims generation.
Search parameters
The full list of search parameters can be found here. Some of the most important are:
Parameters
- patient
- string
The ID of the patient referenced by the document. We recommend using this search parameter along with the $PATIENT_ID wildcard
- type
- string
The type of the document.
- created
- string
The date/time when the document was created.
Sample request
While some servers may support a resource-level search without any parameters, not all do. We recommend using the format below with the patient ID via the $PATIENT_ID wildcard as a search parameter.
This is a sample request using curl
ACCESS_TOKEN=flexpa-link-access-token
curl "https://api.flexpa.com/fhir/DocumentReference?patient=$PATIENT_ID" \
-H "Authorization: Bearer $ACCESS_TOKEN"
Sample response
This is a sample response from Humana using Flexpa API in test mode