General Information
The connectivity of this FHIR endpoint is as follows:
- HTTP Method
- GET, POST
- URL Template
- https://portal.viewmymed.com/fhir/Patient?_count=number&
status=token& _pretty=boolean& _revinclude=static& identifier=token& name=string& given=string& family=string& birthdate=date& gender=token - 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 Patient
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) |
|---|---|
| _count (number) |
The maximum number of results to return in a page. Not honored when '_id' is set. |
| status (token) |
The overall status of the patient. |
| _pretty (boolean) |
set to false to disable formatted output. |
| _revinclude (static) |
_revinclude parameter may be provided once with the value Provenance:target to pull the relevant Provenance information. Example: _revinclude=Provenance:target |
| identifier (token) |
A patient identifier. |
| name (string) |
The beginning of any name of the patient. |
| given (string) |
The beginning of the given name of the patient. |
| family (string) |
The beginning of the family name of the patient. |
| birthdate (date) |
The date of birth of the patient. |
| gender (token) |
The administrative gender of the patient. |
Returned Data Fields
The following fields and bindings are returned if valued
| Field (type) | Description (bindings) | Opt? |
|---|---|---|
| id (Identifier) |
Id - a generated cryptographic unique identifier |
|
| identifier (Identifier) |
Local unique MRN of patient. System is coded with practice unique OID. |
|
| name (HumanName) |
The parts of the patient name, name.given, name.family, name.middle and name.suffix |
|
| name.period (Period) |
Previous/Historical name and documentation of current official name. |
|
| birthDate (Date) |
Patient DOB |
|
| gender (AdministrativeGender) |
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Administrative Gender (http://hl7.org/fhir/ValueSet/administrative-gender) |
|
| telecom (ContactPoint) |
Contact phone number of this Patient |
Y |
| address (Address) |
Address of this Patient |
Y |
| maritalStatus (CodeableConcept) |
Patient Marital Status Marital Status (http://terminology.hl7.org/CodeSystem/v3-MaritalStatus) |
Y |
| ethnicity (Extension) |
US Core Ethnicity Extension US Core Race - ombCategory (urn:oid:2.16.840.1.113883.6.238) |
|
| race (Extension) |
US Core Race Extension US Core Race - ombCategory (urn:oid:2.16.840.1.113883.6.238) |
|
| birthsex (Extension) |
US Core Birth Sex Extension US Core Birth Sex Extension (http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex) |
|
| communication.language (CodeableConcept) |
A language which may be used to communicate with the patient about his or her health. BCP-47 (http://tools.ietf.org/html/bcp47) |
|
| active (Boolean) |
Patient Active in Practice? |
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/Patient?patient=99999.122753-00&_count=1
HTTP/1.0 200 OK
Cache-Control: no-cache, private
Content-Type: application/fhir+json
Date: Mon, 02 Feb 2026 13:43:00 GMT
Etag: W/"1"
{
"resourceType": "Bundle",
"id": "6980a9e44497e6980a9e444981",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://portal.viewmymed.com/api/Patient"
}
],
"entry": [
{
"fullUrl": "https://portal.viewmymed.com/fhir/Patient/99997.122753-00",
"resource": {
"resourceType": "Patient",
"id": "99997.122753-00",
"meta": {
"versionId": "ad598a257e3508e887da1d061b642691",
"lastUpdated": "2023-01-26T06:33:04+00:00"
},
"text": {
"status": "generated",
"div": "
Patient
Name: DeNoto, Philly
DOB: 2018-10-15T00:00:00+00:00
Sex: Male
Status: Active
"
},
"address": [
{
"use": "home",
"line": [
"35 Lawston St"
],
"city": "Rochester",
"state": "NY",
"postalCode": "14607",
"period": {
"start": "2023-01-26T06:33:04+00:00"
}
}
],
"telecom": [
{
"use": "home",
"system": "phone",
"value": "tel:+1-585-244-1648"
}
],
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Not Hispanic or Latino",
"userSelected": false
}
},
{
"url": "text",
"valueString": "Not Hispanic or Latino"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White",
"userSelected": false
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
}
],
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical record number",
"userSelected": false
}
],
"text": "MRN"
},
"system": "urn:oid:2.16.840.1.113883.3.8023.1.50.300011.51",
"value": "99997.122753-00"
}
],
"active": true,
"name": [
{
"use": "official",
"text": "DeNoto, Philly",
"family": "DeNoto",
"given": [
"Philly"
]
}
],
"gender": "male",
"birthDate": "2018-10-15",
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English",
"userSelected": false
}
],
"text": "English"
},
"preferred": true
}
]
}
}
]
}
Error Codes / Outcomes
All endpoints share the same error codes and common outcomes.