Operations and additional interactions
POST search
Any search can also be sent as POST [base]/[type]/_search with an
application/x-www-form-urlencoded body of the same parameters. This is available for:
AllergyIntolerance, CarePlan, CareTeam, Condition, Coverage, Device, DiagnosticReport,
DocumentReference, Encounter, Endpoint, Goal, Immunization, Location, Medication,
MedicationDispense, MedicationRequest, Observation, Organization, Patient, Practitioner,
PractitionerRole, Procedure, Provenance, QuestionnaireResponse, RelatedPerson and ServiceRequest.
Results and authorization are identical to the GET form.
_revinclude=Provenance:target
Resources marked in Resources and search parameters accept
_revinclude=Provenance:target to return the Provenance resources that refer to each match.
DocumentReference/$docref (US Core Fetch DocumentReference)
Returns the patient's DocumentReference resources, as a searchset Bundle. Available as GET
with query parameters or as POST with a FHIR Parameters resource. Scope needed:
patient/DocumentReference.rs (or the user/ or system/ equivalent).
| Parameter | Type | Cardinality | Meaning |
|---|---|---|---|
patient |
id (valueId) |
0..1 | The patient. Optional when the token already carries a patient in context. |
start |
dateTime | 0..1 | Earliest document date. |
end |
dateTime | 0..1 | Latest document date. |
type |
Coding (valueCoding) |
0..* | Document type; `system |
on-demand |
boolean | 0..1 | true or false. |
profile |
canonical (valueCanonical) |
0..* | Requested document profile. |
Any other parameter, a repeated single-valued parameter, or a value of the wrong type is rejected
with HTTP 400 and an OperationOutcome. A request with no parameters returns the patient's
current documents.
POST https://clinic.prevhealth.us/fhir/r4/DocumentReference/$docref
Content-Type: application/fhir+json
{ "resourceType": "Parameters",
"parameter": [ { "name": "patient", "valueId": "<patient id>" } ] }
DocumentReference/{id}/attachment
GET [base]/DocumentReference/<id>/attachment returns the binary content of a classified clinical
document (for example a PDF), with its Content-Type. The same authorization as reading the
DocumentReference applies.
Group/{id}/$export
See Bulk data export.