{"info":{"_postman_id":"af77cccf-8e75-4222-a193-63fd917e64c3","name":"CipherHealth API v0.0.4","description":"<html><head></head><body><p>This documentation will describe the HTTP endpoints available to registered CipherHealth clients and technology partners. To get access, existing care providers should reach out directly to the Customer Success Managers.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11199668","collectionId":"af77cccf-8e75-4222-a193-63fd917e64c3","publishedId":"T1LTdj1h","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"1C4A67","highlight":"22B4A4"},"publishDate":"2020-08-20T02:39:50.000Z"},"item":[{"name":"v1/epic/sms","item":[{"name":"GET Epic SMS Gateway","id":"973224e9-bb4d-4e85-a4f0-22dfdc6af751","request":{"method":"GET","header":[],"url":"https://api.cipherhealth.com/v1/epic/sms?message=<string>&phoneTo=<phone>","description":"<p>Allows a user to forward Epic SMS requests like MyChart activation notifications through the CipherHealth API and deliver it to a patient.  Additional information is included inside the <code>%msg%</code> field to enable further data mapping or outreach program enrollment.</p>\n","urlObject":{"path":["v1","epic","sms"],"host":["https://api.cipherhealth.com"],"query":[{"description":{"content":"<p>(Required) A pipe delimited string which contains the the rest of the parameters required for the SMS notification. For pipe delimited submissions, the pattern is <code>field|value|field|value</code> where value is a standard input or a SmartText field like <code>%LNAME%</code>.  A <code>type</code> field is required and must be one of the followin: <code>mychart-activation</code>,<code>fastpass</code>,<code>mychart-mfa</code>, or <code>generic</code>.</p>\n","type":"text/plain"},"key":"message","value":"<string>"},{"description":{"content":"<p>(Required) The phone number that should receive the SMS notification.</p>\n","type":"text/plain"},"key":"phoneTo","value":"<phone>"}],"variable":[]}},"response":[{"id":"cb835bb1-f7a6-456e-90d5-2408c26a957a","name":"Notification Sent (delimited)","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cipherhealth.com/v1/epic/sms?message=<string>&phoneTo=<phone>","host":["https://api.cipherhealth.com"],"path":["v1","epic","sms"],"query":[{"key":"message","value":"<string>"},{"key":"phoneTo","value":"<phone>"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"},{"id":"d3358c5d-9ee1-4575-9008-10b1f7582c2f","name":"Authentication information is missing or invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cipherhealth.com/v1/epic/sms?message=<string>&phoneTo=<phone>","host":["https://api.cipherhealth.com"],"path":["v1","epic","sms"],"query":[{"key":"message","value":"<string>"},{"key":"phoneTo","value":"<phone>"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Unauthorized\"\n}"},{"id":"ede9eed1-1852-4a12-a58b-3e35ca43b05b","name":"Missing Parameters","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.cipherhealth.com/v1/epic/sms?message=<string>&phoneTo=<phone>","host":["https://api.cipherhealth.com"],"path":["v1","epic","sms"],"query":[{"key":"message","value":"<string>"},{"key":"phoneTo","value":"<phone>"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"A phone number is required\"\n}"}],"_postman_id":"973224e9-bb4d-4e85-a4f0-22dfdc6af751"},{"name":"POST Epic SMS Gateway","id":"312fd6c4-459a-4281-a602-8a3f3be16e4c","request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"key":"message","value":"<string>","type":"text","description":"<p>A stringified json object or pipe delimited string which contains the the rest of the parameters required for the SMS notification.  For json, the double quotes in the SmartText template may require escaping.  For pipe delimited submissions, the pattern is <code>field|value|field|value</code> where value is a standard input or a SmartText field like <code>%LNAME%</code></p>\n"},{"key":"phoneTo","value":"<phone>","type":"text","description":"<p>The phone number that should receive the SMS notification.</p>\n"}]},"url":"https://api.cipherhealth.com/v1/epic/sms?type=fieldpipe","description":"<p>Allows a user to forward Epic SMS requests like MyChart activation notifications through the CipherHealth API and deliver it to a patient.  Additional information is included inside the <code>%msg%</code> field to enable further data mapping or outreach program enrollment.</p>\n","urlObject":{"path":["v1","epic","sms"],"host":["https://api.cipherhealth.com"],"query":[{"description":{"content":"<p>Type of embedding used inside the %msg% smart text.  The <code>json</code> type uses a stringified json structure, but may not properly handle SmartText embedded fields with double-quotes.  The <code>fieldpipe</code> is more robust and is the default.</p>\n","type":"text/plain"},"key":"type","value":"fieldpipe"}],"variable":[]}},"response":[{"id":"617445e5-b9b2-492c-acb7-d6cbecbc9e93","name":"Notification Sent (delimited)","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":{"content":"A stringified json object or pipe delimited string which contains the the rest of the parameters required for the SMS notification.  For json, the double quotes in the SmartText template may require escaping.  For pipe delimited submissions, the pattern is `field|value|field|value` where value is a standard input or a SmartText field like `%LNAME%`","type":"text/plain"},"key":"message","value":"<string>","type":"text"},{"description":{"content":"The phone number that should receive the SMS notification.","type":"text/plain"},"key":"phoneTo","value":"+16232514928","type":"text"}]},"url":{"raw":"https://api.cipherhealth.com/v1/epic/sms?type=fieldpipe","host":["https://api.cipherhealth.com"],"path":["v1","epic","sms"],"query":[{"key":"type","value":"fieldpipe"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"},{"id":"64909c57-5b13-46fc-990a-10757a4d2338","name":"Authentication information is missing or invalid","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":{"content":"A stringified json object or pipe delimited string which contains the the rest of the parameters required for the SMS notification.  For json, the double quotes in the SmartText template may require escaping.  For pipe delimited submissions, the pattern is `field|value|field|value` where value is a standard input or a SmartText field like `%LNAME%`","type":"text/plain"},"key":"message","value":"<string>","type":"text"},{"description":{"content":"The phone number that should receive the SMS notification.","type":"text/plain"},"key":"phoneTo","value":"+16232514928","type":"text"}]},"url":{"raw":"https://api.cipherhealth.com/v1/epic/sms?type=fieldpipe","host":["https://api.cipherhealth.com"],"path":["v1","epic","sms"],"query":[{"key":"type","value":"fieldpipe"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Unauthorized\"\n}"},{"id":"affa77b7-a458-441e-bf3a-da01b465ac5c","name":"Missing Parameters","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":{"content":"A stringified json object or pipe delimited string which contains the the rest of the parameters required for the SMS notification.  For json, the double quotes in the SmartText template may require escaping.  For pipe delimited submissions, the pattern is `field|value|field|value` where value is a standard input or a SmartText field like `%LNAME%`","type":"text/plain"},"key":"message","value":"<string>","type":"text"},{"description":{"content":"The phone number that should receive the SMS notification.","type":"text/plain"},"key":"phoneTo","value":"+16232514928","type":"text"}]},"url":{"raw":"https://api.cipherhealth.com/v1/epic/sms?type=fieldpipe","host":["https://api.cipherhealth.com"],"path":["v1","epic","sms"],"query":[{"key":"type","value":"fieldpipe"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"code\": 400,\n \"message\": \"A phone number is required\"\n}"}],"_postman_id":"312fd6c4-459a-4281-a602-8a3f3be16e4c"}],"id":"335bf03d-be50-471a-88c9-4cca5dc83d8d","_postman_id":"335bf03d-be50-471a-88c9-4cca5dc83d8d","description":""}],"variable":[{"id":"baseUrl","key":"baseUrl","value":"https://api.cipherhealth.com","type":"string"}]}