Base structure definition
API Endpoints
READ
The [patient|user|system]/DocumentReference.read scope is required.
GET /fhir/DocumentReference/{id}
| Parameter |
Type |
Description |
id |
string |
Required. The logical id of the resource |
Response Codes
| Code |
Description |
| 200 OK |
The requested DocumentReference resource within the body of the HTTP response. |
| 400 Bad Request |
The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description |
| 404 Not Found |
The requested resource does not exist. |
| 500 Internal Server Error |
An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description |
GET Search
The [patient|user|system]/DocumentReference.read scope is required.
GET /fhir/DocumentReference
| Parameter |
Type |
Description |
patient |
reference |
Conditional Required. Patient reference. Required if _id is not provided |
_id |
token |
Conditional Required. DocumentReference.id resource reference to FHIR DocumentReference resource. Required if patient is not provided |
date |
date |
DocumentReference.date is the parameter used when searching on date |
category |
token |
DocumentReference.category is the parameter used when searching on category |
type |
token |
DocumentReference.type is the parameter used when searching on type |
_revinclude |
string |
Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Supported values: Provenance:target
|
Response Codes
| Code |
Description |
| 200 OK |
The body of the response will contain a Bundle resource. |
| 400 Bad Request |
The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description |
| 404 Not Found |
The requested resource does not exist. |
| 500 Internal Server Error |
An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description |
POST Search
The [patient|user|system]/DocumentReference.read scope is required.
POST /fhir/DocumentReference/_search
| Parameter |
Type |
Description |
patient |
reference |
Conditional Required. Patient reference. Required if _id is not provided |
_id |
token |
Conditional Required. DocumentReference.id resource reference to FHIR DocumentReference resource. Required if patient is not provided |
date |
date |
DocumentReference.date is the parameter used when searching on date |
category |
token |
DocumentReference.category is the parameter used when searching on category |
type |
token |
DocumentReference.type is the parameter used when searching on type |
_revinclude |
string |
Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Supported values: Provenance:target
|