HiMS API Documentation

The Device resources represent items used in the provision of healthcare, including medical devices such as durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research. Specifically, resources for implantable devices use the US Core Implantable Device profile.

The Device resource returns data classes and elements defined for Unique Device Identifier(s) for a Patient’s Implantable Device(s) in United States Core Data for Interoperability (USCDI v2). Examples of API requests to retrieve device data are shown below:

Get implantable devices associated with a specific patient

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/Device?patient={patientId}&_profile=http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/Device?patient=29355&_profile=http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device
                    

Response schema

{
  "type": "object",
  "required": [],
  "properties": {
    "resourceType": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "link": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "relation": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "entry": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "fullUrl": {
            "type": "string"
          },
          "resource": {
            "type": "object",
            "required": [],
            "properties": {
              "resourceType": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "meta": {
                "type": "object",
                "required": [],
                "properties": {
                  "versionId": {
                    "type": "string"
                  },
                  "lastUpdated": {
                    "type": "string"
                  },
                  "profile": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              },
              "udiCarrier": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "deviceIdentifier": {
                      "type": "string"
                    },
                    "carrierHRF": {
                      "type": "string"
                    }
                  }
                }
              },
              "status": {
                "type": "string"
              },
              "distinctIdentifier": {
                "type": "string"
              },
              "manufactureDate": {
                "type": "string"
              },
              "expirationDate": {
                "type": "string"
              },
              "lotNumber": {
                "type": "string"
              },
              "serialNumber": {
                "type": "string"
              },
              "deviceName": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    }
                  }
                }
              },
              "type": {
                "type": "object",
                "required": [],
                "properties": {
                  "coding": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "system": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              },
              "patient": {
                "type": "object",
                "required": [],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}