InstantMessage
An InstantMessage resource is used to describe a message between persons and organizations in HealthGorilla Application. A message is a composite object that contains a sender and recipients, a subject, a message body and attachments. Users may send and receive messages from physicians, practice staff, patients, and healthcare organizations.
An InstantMessage is designed to describe HealthGorilla Secure Messages and should not be used for other purposes.
An InstantMessage can contain DiagnosticReport, RequestGroup, DocumentReference, ReferralRequest as attachments.
https://api.healthgorilla.com/fhir/InstantMessage
FHIR Operations
The following operations are currently supported:
1. Read
HTTP Request | Method | Action |
---|---|---|
/InstantMessage/{ID}?_format=json | GET | Get message by ID |
2. Search
HTTP Request | Method | Action |
---|---|---|
/InstantMessage?[parameter={value}] | GET | Returns DirectMessage resources matching the filter specified as a parameter |
Parameters:
Key | Type | Description |
---|---|---|
direction | Token | OUT for outgoing messages and IN for incoming |
identifier | Token | InstantMessage identifier |
_lastUpdated | Date | Return InstantMessage resources modified after the specified date. E.g. gt2019-09-05 |
Examples
2.1 Retrieve all incoming messages received starting from 09/05/2019
https://api.healthgorilla.com/fhir/InstantMessage?
direction=IN
&_lastUpdated=gt2019-09-05
&_format=json
2.2 Retrieve InstantMessage resource with identifier of 35f3d35d12aa8d93dd9953c0
https://api.healthgorilla.com/fhir/InstantMessage?
identifier=https://www.healthgorilla.com|35f3d35d12aa8d93dd9953c0
&_format=json
Updated about 1 year ago