Device

Unique Device Identifier(s) for Patient's Implantable Device(s) - This represents Devices - information about durable, manufactured medical items; specifically - implantable medical devices.

General Information

The connectivity of this FHIR endpoint is as follows:

HTTP Method
GET, POST
URL Template
https://portal.viewmymed.com/fhir/Device?_id=token&patient=reference&_count=number&date=date&status=token&_pretty=boolean&_revinclude=static
Supported OAuth 2.0 User Types
Backend Systems, Clinicians or Administrative Users, Patients
Profiles Supported
  • Us Core Device
  • 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 Device ids. It is a required field if the patient field is not given.
    patient
    (reference)
    Who the device is for. It is a required field if the _id 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 device. 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 device at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for device within a specific range. The date prefix pair must create a closed range.
    status
    (token)
    The overall status of the device.
    _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

    Returned Data Fields

    The following fields and bindings are returned if valued

    Field (type) Description (bindings) Opt?
    id
    (Id)
    Id
    patient
    (Reference)
    Reference to a patient resource for whom the problem list is relevant
    status
    (String)
    Whether implant is active
    udiCarrier
    (String)
    Unique Device Identifier (UDI) is a unique numeric or alphanumeric code that is comprised of two components: Device Identifier (DI)- a mandatory, fixed portion of a UDI that identifiers the labeler and specific version or model of a device, and a Production Identifiers (PI)
    distinctIdentifier
    (String)
    Distinct identification code.
    manufactureDate
    (DateTime)
    Date of device manufacture.
    expirationDate
    (DateTime)
    Device expiration date.
    lotNumber
    (String)
    Device lot number.
    serialNumber
    (String)
    Device serial number.
    type
    (CodeableConcept)
    A SNOMED or other device code.

    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/Device?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:41:34 GMT
    Etag:          W/"1"
    
    {
        "resourceType": "Bundle",
        "id": "6980a98ec19346980a98ec1937",
        "type": "searchset",
        "link": [
            {
                "relation": "self",
                "url": "https://portal.viewmymed.com/api/Device"
            }
        ],
        "entry": [
            {
                "fullUrl": "https://portal.viewmymed.com/fhir/Device/4d84fd4cc6ad50d53f502f851b972508",
                "resource": {
                    "resourceType": "Device",
                    "id": "4f325b0b1e466f75e53105dbf4a1c5a9",
                    "meta": {
                        "versionId": "4d84fd4cc6ad50d53f502f851b972508",
                        "lastUpdated": "2023-01-26T06:33:04+00:00"
                    },
                    "text": {
                        "status": "generated",
                        "div": "

    Implanted: Cardiag resynchronization therapy implantable pacemaker

    \n

    Area: Subclavian Vein

    \n

    UDI: (01)43069338026389(10)1134(21)842026117977

    \n
    " }, "patient": { "reference": "Patient/99997.122753-00" }, "status": "active", "udiCarrier": [ { "carrierAIDC": "NDMwNjkzMzgwMjYzODk=", "deviceIdentifier": "43069338026389", "carrierHRF": "(01)43069338026389(10)1134(21)842026117977" } ], "distinctIdentifier": "43069338026389", "manufactureDate": "1970-01-01T00:00:00+00:00", "expirationDate": "1970-01-01T00:00:00+00:00", "lotNumber": "1134", "serialNumber": "842026117977", "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "14106009" } ], "text": "Cardiag resynchronization therapy implantable pacemaker" } } } ] }

    Error Codes / Outcomes

    All endpoints share the same error codes and common outcomes.