DocumentReference
The DocumentReference resource provides "a reference to a document of any kind for any purpose". It also "provides metadata about the document so that the document can be discovered and managed." (HL7 FHIR R4 DocumentReference)
Supported Profiles
This API supports the following FHIR profiles:
Operations
The Certified API DocumentReference resources supports the following standard operations. However, support varies by the targeted CareRecord or solution.
| CareRecord / Solution | Create | Read | Update | Search |
|---|---|---|---|---|
| GEHRIMED | - | Yes | - | Yes |
| myAvatar | - | Yes | - | Yes |
| myEvolv | - | Yes | - | Yes |
| myUnity | - | Yes | - | Yes |
| TheraOffice | - | Yes | - | Yes |
Search
info
Not all Netsmart solutions support DocumentReference search. See supported operations table above and consult your target solution's documentation for more information.
This operation retrieves a list of resources by these query parameters.
Standard Parameters
| Name | Type | Description |
|---|---|---|
| category | token | Categorization of document. |
| date | date | When this document reference was created. |
| page | string | Zero-based page index |
| patient | reference | Who/what is the subject of the document. |
| type | token | Kind of document (LOINC if possible). |
| _id | id | Unique identifier of the DocumentReference. |
| _revinclude | special | Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target" |
Search Examples
Via POST
The POST method is recommended as it keeps health information out of the URL.
- Production
- Preview
Search by Patient and Type
curl -X POST https://fhir.netsmartcloud.com/uscore/v1/DocumentReference/_search \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-form-urlencoded" \
-d "patient=Patient/123" \
-d "type=http://loinc.org|18748-4"
Search by Patient and Type
curl -X POST https://fhirtest.netsmartcloud.com/uscore/v1/DocumentReference/_search \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-form-urlencoded" \
-d "patient=Patient/123" \
-d "type=http://loinc.org|18748-4"
Via GET
- Production
- Preview
Search by Patient and Type
curl -X GET "https://fhir.netsmartcloud.com/uscore/v1/DocumentReference?patient=Patient/123&type=http://loinc.org%7C18748-4" \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json"
Search by Patient and Type
curl -X GET "https://fhirtest.netsmartcloud.com/uscore/v1/DocumentReference?patient=Patient/123&type=http://loinc.org%7C18748-4" \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json"