General Information
The connectivity of this FHIR endpoint is as follows:
- HTTP Method
- GET, POST
- URL Template
- https://portal.viewmymed.com/fhir/DocumentReference?_id=token&
_count=number& date=date& _pretty=boolean& category=token& code=token& type=token - Supported OAuth 2.0 User Types
- Backend Systems, Clinicians or Administrative Users, Patients
- Operations Supported
- read search-type vread history-instance
- Scopes Supported
-
- patient/DocumentReference
- user/DocumentReference
- system/DocumentReference
- system/*.read
- system/*.rs
- Profiles Supported
-
- Us Core Diagnosticreport Note
- Us Core Diagnosticreport Lab
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 DocumentReference 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 documentreference. 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 documentreference at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for documentreference within a specific range. The date prefix pair must create a closed range. |
| _pretty (boolean) |
set to false to disable formatted output. |
| category (token) |
Which diagnostic discipline/department created the report. |
| code (token) |
The code for the report. |
| type (token) |
A single or comma separated list of classifications of the type of observation. |
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 |
|
| author (Reference) |
Reference to a author for whom the report is relevant |
|
| custodian (Reference) |
Reference to a custodial organization for whom the report is relevant |
|
| identifier (Id) |
Unique identifier for this scan record if document is scanned. |
|
| status (String) |
Whether the document is completed/final or otherwise. DocumentReferenceStatus (http://hl7.org/fhir/document-reference-status) |
|
| date (DateTime) |
The date and time that this version of the report was made available to providers, typically after the report was reviewed and verified. |
|
| type (CodeableConcept) |
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. LOINC (http://loinc.org) |
|
| category (CodeableConcept) |
Hard Coded to "clinical-note" US Core DocumentReference Category (http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category) |
|
| content (Attachment) |
If the document has a scan or rendered document, this attachment represents this document. I.E. Lab results may not have a presented form. |
|
| context.encounter (Reference) |
Reference to a patient encounter for whom the report is relevant |
|
| context.period (Period) |
Encounter Period |
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/DocumentReference?_id=ba4930ab7dc77310169eb3efe8f69d39
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": "6980a9e49e1f36980a9e49e1f5",
"type": "searchset",
"link": [
{
"relation": "self",
"url": "https://portal.viewmymed.com/api/DocumentReference"
}
],
"entry": [
{
"fullUrl": "https://portal.viewmymed.com/fhir/DocumentReference/ba4930ab7dc77310169eb3efe8f69d39",
"resource": {
"resourceType": "DocumentReference",
"meta": {
"versionId": "ba4930ab7dc77310169eb3efe8f69d39",
"lastUpdated": "2023-01-18T04:16:55+00:00"
},
"identifier": [
{
"use": "usual",
"system": "urn:oid:2.16.840.1.113883.3.8023.99.99997",
"value": "99997.00033401"
}
],
"id": "ba4930ab7dc77310169eb3efe8f69d39",
"status": "current",
"date": "2023-01-04T00:00:00+00:00",
"subject": {
"reference": "Patient/99997.122753-00"
},
"author": [
{
"reference": "Practitioner/61d8609f1b829a2125f5c1601b328d9a"
}
],
"custodian": {
"reference": "Organization/069dca595f357b1011b5b74ba54b51c9"
},
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "18842-5",
"display": "Discharge Summary"
}
],
"text": "Discharge Summary"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
],
"text": "Clinical Note"
}
],
"content": [
{
"attachment": {
"contentType": "text/rtf",
"url": "https://portal.viewmymed.com/fhir/Binary/ba4930ab7dc77310169eb3efe8f69d39",
"data": "ZTF4eWRHWXhYR0Z1YzJsY1lXNXphV053WnpFeU5USmNaR1ZtWmpCY1pHVm1iR0Z1WnpFd016TmNaR1ZtZEdGaU1qRTJNSHRjWm05dWRIUmliSHRjWmpCY1puSnZiV0Z1WEdad2NuRXlYR1pqYUdGeWMyVjBNQ0JVYVcxbGN5Qk9aWGNnVW05dFlXNDdmWHRjWmpGY1puTjNhWE56WEdaamFHRnljMlYwTUNCVWFXMWxjeUJPWlhjZ1VtOXRZVzQ3Zlh0Y1pqSmNabkp2YldGdVhHWndjbkV5WEdaamFHRnljMlYwTWlCVGVXMWliMnc3ZlgxN1hHTnZiRzl5ZEdKc0lEdGNjbVZrTUZ4bmNtVmxiakV5T0Z4aWJIVmxNalUxTzF4eVpXUXlOVFZjWjNKbFpXNHdYR0pzZFdVd08zMWNkbWxsZDJ0cGJtUTBYSFZqTVZ4d1lYSmtYR1p6TWpBZ1ZHaHBjeUJwY3lCaElHUnBjMk5vWVhKblpTQnViM1JsRFFwY2NHRnlJQTBLWEhCaGNpQmNaakJjWWx4cElDMG9WbUZzZFdWa0lFTnNhV1Z1ZENsY1lqQmNhVEJjWmpFZ0lDQWdJQ0F3TVM4d05DOHlNeUFnSURNNk1URndiUTBLWEhCaGNpQjlEUW89"
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/59a9d34cd65224c1b37260122777ea68"
}
],
"period": {
"start": "2023-01-04T00:00:00+00:00",
"end": "2023-01-04T00:00:00+00:00"
}
}
}
}
]
}
Error Codes / Outcomes
All endpoints share the same error codes and common outcomes.