API Data Models Introduction
Our Data Models are the framework our Emissary APIs use to exchange data between third party applications and health systems. Emissary is the only true RESTful API solution that seamlessly exchanges data with our supported electronic health record (EHR) systems.
You can browse through our data models to understand what data elements Emissary supports and use it as you are coding your application to use Emissary.
What kinds of calls do you support
With Emissary there are the http methods (REST terms which describe the action you are taking with a particular resource) used to interact with a resource (patient or clinical element exposed that all subsequent fields are built to support i.e. Medication Orders is a resource). We support GET, POST, PUT, and DELETE.
We also have structured our APIs to call the resources in varying ways to meet many different diverse use cases.
Resource List: A list call will be our standard naming convention such as GET Documents which will return a list of whichever resource it is associated to. If it is associated with a patient Id, it will return a list of the resource associated to that patient. i.e. GET Documents will return all documents associated with a patient.
Resource by Id: This call returns a very specific resource such as a specific Medication Order. The object returned is very similar to the list object, however, it will only return information for that specific resource Id.
Resource Discovery: Emissary discovery calls are patent pending. They allow us to expose EHR specific configurations or fields which is incredibly helpful when doing initial mapping exercises or writing back to the EHR. Our discovery calls expose the resource tables in the EHR so that you can understand the specific fields an EHR has programed. Such as GET References/Problem Codes – this API will expose all of the specific problem codes a system supports. These are typically used when first mapping an app to a hospital system and then whenever making subsequent POST or PUT calls back to the EHR to ensure the app is writing back to the system in the same “language”. This can be incredibly helpful as system A may have 6 options for “Religion” where system B has 20 options for “Religion”. Discovery calls help you to better understand the system.
Population Resource: Emissary population calls provide an application a unique opportunity to “listen” to the system and its activities. For a given time period, it will return all of the resource type data across the system – so it is not patient specific. This is a fantastic method to use to fuel large algorithms or support surveillance type applications. i.e. Our GET Population Orders will show all orders that were processed in the system for a given time period. Our population calls can be a very powerful tool.