Encounter
The Encounter resource provides "an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient." (HL7 FHIR R4 Encounter)
Supported Profiles
This API supports the following FHIR profiles:
Operations
The Certified API Encounter resource 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 Encounter 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.
Search Parameters
| Name | Type | Description |
|---|---|---|
| patient | reference | REQUIRED The patient or group present at the encounter |
| date | date | A date within the period the Encounter lasted |
| page | string | Zero-based page index |
| _id | id | Unique identifier of the Encounter. |
| _revinclude | special | Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target" |
Search Example
Via POST
The POST method is recommended as it keeps health information out of the URL.
- Production
- Preview
Search by Patient and Date
curl -X POST https://fhir.netsmartcloud.com/uscore/v1/Encounter/_search \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-form-urlencoded" \
-d "patient=Patient/123" \
-d "date=ge2023-07-10"
Search by Patient and Date
curl -X POST https://fhirtest.netsmartcloud.com/uscore/v1/Encounter/_search \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-form-urlencoded" \
-d "patient=Patient/123" \
-d "date=ge2023-07-10"
Via GET
- Production
- Preview
Search by Patient and Date
curl -X GET "https://fhir.netsmartcloud.com/uscore/v1/Encounter?patient=Patient/123&date=ge2023-07-10" \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json"
Search by Patient and Date
curl -X GET "https://fhirtest.netsmartcloud.com/uscore/v1/Encounter?patient=Patient/123&date=ge2023-07-10" \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json"