General Information
The connectivity of this FHIR endpoint is as follows:
- HTTP Method
- GET, POST
- URL Template
- https://portal.viewmymed.com/fhir/Encounter?_id=token&
_count=number& date=date& _pretty=boolean& identifier=token& patient=reference - Supported OAuth 2.0 User Types
- Backend Systems, Clinicians or Administrative Users, Patients
- Operations Supported
- read search-type vread history-instance
- Profiles Supported
-
- Us Core Encounter
Request Parameters
The following fields and datatypes are the parameters for the request string. All fields are optional, however if no settings are set, all values will be exported up to the maximum count of 100
| Name (type) | Description (bindings) |
|---|---|
| _id (token) |
A single or comma separated list of Encounter ids. It is a required field if the patient field is not given. |
| _count (number) |
The maximum number of results to return in a page. Not honored when '_id' is set. |
| date (date) |
A date or date range from which to find encounter. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for encounter at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for encounter within a specific range. The date prefix pair must create a closed range. |
| _pretty (boolean) |
set to false to disable formatted output. |
| identifier (token) |
An encounter's identifier. It is a required field if the account or _id or patient or subject fields are not given. |
| patient (reference) |
Who the encounter is for. It is a required field if the _id field is not given. |
Returned Data Fields
The following fields and bindings are returned if valued
| Field (type) | Description (bindings) | Opt? |
|---|---|---|
| id (Id) |
Id |
|
| subject (Reference) |
Reference to a patient resource for whom the report is relevant |
|
| identifier (Id) |
Unique identifier for this scan record if document is scanned. |
|
| status (String) |
Visit status |
|
| class (CodeableConcept) |
Patient Class. Medpointe does not support non ambulatory workflows, hardcoded to "AMB" Patient Class (http://terminology.hl7.org/CodeSystem/v3-ActCode) |
|
| participant.period (Period) |
Period where participant interacted with patient |
|
| participant.individual (Reference) |
Reference to a participant for whom the encounter occured |
|
| period (Period) |
Encounter Time Period, Scheduled Check-In and Check-Out times. |
|
| hospitalization (CodeableConcept) |
Discharge Disposition. Discharge Disposition (http://hl7.org/fhir/discharge-disposition) |
|
| location (CodeableConcept) |
Location where visit occured |
|
| type (Period) |
Encounter Period SNOMED CT (http://snomed.info/sct) |
|
| reasonCode (Reference) |
Reason For Visit / Admitting Diagnoses SNOMED CT (http://snomed.info/sct) |
Default Patient Query
The following are live queries representative of a data request on our sandbox environment.
Headers
Accept: application/fhir+json Authorization: <OAuth2 Bearer Token>
Request
GET https://portal.viewmymed.com/fhir/Encounter?_id=fb9f088c689044da7a617c6ae144be05
HTTP/1.0 200 OK
Cache-Control: no-cache, private
Content-Type: application/fhir+json
Date: Mon, 02 Feb 2026 13:36:07 GMT
Etag: W/"1"
{
"resourceType": "Encounter",
"meta": {
"versionId": "fb9f088c689044da7a617c6ae144be05",
"lastUpdated": "2023-01-20T15:20:15+00:00"
},
"id": "fb9f088c689044da7a617c6ae144be05",
"identifier": [
{
"use": "usual",
"system": "urn:oid:2.16.840.1.113883.3.8023.1.50.300011.51",
"value": "fb9f088c689044da7a617c6ae144be05"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB"
},
"subject": {
"reference": "Patient/99997.122753-00"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
],
"text": "primary performer"
}
],
"period": {
"start": "2023-01-20T10:00:00+00:00",
"end": "2023-01-20T10:10:00+00:00"
},
"individual": {
"reference": "Practitioner/6d102433793cace904174bebb6379f13"
}
}
],
"hospitalization": {
"dischargeDisposition": {
"coding": [
{
"system": "http://www.nubc.org/patient-discharge",
"code": "01",
"display": "Discharged to home care or self care (routine discharge)"
}
],
"text": "Discharged to home care or self care (routine discharge)"
}
},
"location": [
{
"location": {
"reference": "Location/6d102433793cace904174bebb6379f13"
}
}
],
"period": {
"start": "2023-01-20T10:00:00+00:00",
"end": "2023-01-20T10:10:00+00:00"
},
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "185345009"
}
],
"text": "Encounter for symptom"
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown"
}
]
}
]
}
Error Codes / Outcomes
All endpoints share the same error codes and common outcomes.