{"items":[{"type":"link","label":"Intake API","link":"/intake-api/openapi","routeSlug":"/intake-api/openapi","content":{"contentType":"overview","meta":{"name":"Intake API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/intake-api/@2024-12-10/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/intake-api/@2024-12-10/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Intake API (2024-12-10)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This API allows prescribers to send new prescriptions to Gifthealth to be filled. This API is intended only for use by prescribers and their software vendors."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In order to use this API, you must have an active agreement and/or attestation with Gifthealth. If you are interested in using this API, please contact Gifthealth."},"children":[]}]}]}]}]}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"group","label":"Events","link":"/intake-api/openapi/events","routeSlug":"/intake-api/openapi/events","items":[{"label":"Get all events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/events/getevents","routeSlug":"/intake-api/openapi/events/getevents","metadata":{"seo":{"title":"Get all events","description":"Get all events"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEvents","name":"Get all events","isWebhook":false,"pointer":"/paths/~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:events:read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"iterator","in":"query","schemaId":"schema_0"},{"name":"limit","in":"query","schemaId":"schema_1","description":"Maximum number of events to return, anywhere from 1 to 250. Default is 250."}],"pointer":"/paths/~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[],"query":[{"name":"iterator","in":"query","required":false,"schemaId":"schema_0"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:events:read"]}],"responseCodes":["200","401"],"pointer":"/events","href":"events/getevents","openApiOperationId":"getEvents","summary":"Get all events","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:events:read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_2","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/default"]}],"pointer":"/paths/~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~1events/get/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1events/get/responses/401/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/getevents"}],"panels":[]}]},"httpPath":"/events"},{"label":"Get an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/events/getevent","routeSlug":"/intake-api/openapi/events/getevent","metadata":{"seo":{"title":"Get an event","description":"Get an event"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEvent","name":"Get an event","isWebhook":false,"pointer":"/paths/~1events~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get an event","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:events:read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1events~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/events/{id}","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:events:read"]}],"responseCodes":["200","401","404"],"pointer":"/events/{id}","href":"events/getevent","openApiOperationId":"getEvent","summary":"Get an event","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:events:read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1events~1{id}/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_4","exampleIds":["paths/~1events~1{id}/get/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/404/content/application~1json/examples/default"]}],"pointer":"/paths/~1events~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","exampleIds":["paths/~1events~1{id}/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1events~1{id}/get/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1events~1{id}/get/responses/404/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/events/getevent"}],"panels":[]}]},"httpPath":"/events/{id}"}],"content":{"contentType":"group","meta":{"name":"Events"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Events","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events allow you to receive updates about prescriptions as they move through the dispensing process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an important part of the dispensing process happens for a prescription, we publish an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the event feed if there is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" record with matching demographic and prescription information (termed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PrescriptionIdentity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You don't need to worry about creating subscriptions if you use our Intake API to send prescriptions to Gifthealth. We automatically create subscriptions for you."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The events endpoint is stateless, and assumes a single consumer. Events are not removed from the events endpoint when they are read."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events currently remain visible in the events endpoint indefinitely, but this may change in the future. Design your system with the understanding that event availability has a limited timeframe."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You are responsible for tracking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iterator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value as you process items from the queue. You can replay events as needed by resetting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"iterator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value to an earlier value."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/events","summary":"Get all events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/getevents","deprecated":false},{"title":"/events/{id}","summary":"Get an event","prefix":{"name":"get","color":"get"},"badges":[],"link":"/events/getevent","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/intake-api/openapi/subscriptions","routeSlug":"/intake-api/openapi/subscriptions","items":[{"label":"Create a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/subscriptions/createsubscription","routeSlug":"/intake-api/openapi/subscriptions/createsubscription","metadata":{"seo":{"title":"Create a subscription","description":"Create a subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscription","name":"Create a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:subscriptions:write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionInput","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/default"]}},"schemaId":"components/schemas/SubscriptionInput","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:subscriptions:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionInput","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/default"]}},"responseCodes":["201","400","401","422"],"pointer":"/subscriptions","href":"subscriptions/createsubscription","openApiOperationId":"createSubscription","summary":"Create a subscription","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:subscriptions:write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"schemaId":"components/schemas/SubscriptionInput","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionInput","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/default"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/default"]}},"schemaId":"schema_5","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/default"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/default"]},{"code":"422","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/default"]}},"schemaId":"schema_6","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/default"]}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_5","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"schema_6","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/createsubscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Get a subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/subscriptions/getsubscription","routeSlug":"/intake-api/openapi/subscriptions/getsubscription","metadata":{"seo":{"title":"Get a subscription","description":"Get a subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscription","name":"Get a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:subscriptions:read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1subscriptions~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{id}","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:subscriptions:read"]}],"responseCodes":["200","401","404"],"pointer":"/subscriptions/{id}","href":"subscriptions/getsubscription","openApiOperationId":"getSubscription","summary":"Get a subscription","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:subscriptions:read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/404/content/application~1json/examples/default"]}],"pointer":"/paths/~1subscriptions~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/get/responses/404/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/getsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"},{"label":"Cancel a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/subscriptions/cancelsubscription","routeSlug":"/intake-api/openapi/subscriptions/cancelsubscription","metadata":{"seo":{"title":"Cancel a subscription","description":"Cancel a subscription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelSubscription","name":"Cancel a subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:subscriptions:write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1subscriptions~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{id}","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:subscriptions:write"]}],"responseCodes":["200","401","404"],"pointer":"/subscriptions/{id}","href":"subscriptions/cancelsubscription","openApiOperationId":"cancelSubscription","summary":"Cancel a subscription","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:subscriptions:write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/default"]}],"pointer":"/paths/~1subscriptions~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/cancelsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{id}"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events are published to your events endpoint when they match a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Subscriptions are created in one of two ways:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions are automatically created for prescriptions sent to Gifthealth through the Intake API."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions can be created for prescriptions received via fax or eRx using these endpoints. You are responsible for matching Gifthealth events to your own prescription records using the prescription's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PrescriptionIdentity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attributes."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions","summary":"Create a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/createsubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Get a subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/getsubscription","deprecated":false},{"title":"/subscriptions/{id}","summary":"Cancel a subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/cancelsubscription","deprecated":false}]}]}]}]}},{"type":"group","label":"Prescriptions","link":"/intake-api/openapi/prescriptions","routeSlug":"/intake-api/openapi/prescriptions","items":[{"label":"Send a prescription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/prescriptions/createprescription","routeSlug":"/intake-api/openapi/prescriptions/createprescription","metadata":{"seo":{"title":"Send a prescription","description":"Send a prescription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPrescription","name":"Send a prescription","isWebhook":false,"pointer":"/paths/~1prescriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a prescription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:prescriptions:write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrescriptionInput","exampleIds":["paths/~1prescriptions/post/requestBody/content/application~1json/examples/default"]}},"schemaId":"components/schemas/PrescriptionInput","exampleIds":["paths/~1prescriptions/post/requestBody/content/application~1json/examples/default"],"pointer":"/paths/~1prescriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/prescriptions","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:prescriptions:write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PrescriptionInput","exampleIds":["paths/~1prescriptions/post/requestBody/content/application~1json/examples/default"]}},"responseCodes":["201","400","401","422"],"pointer":"/prescriptions","href":"prescriptions/createprescription","openApiOperationId":"createPrescription","summary":"Send a prescription","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:prescriptions:write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"schemaId":"components/schemas/PrescriptionInput","exampleIds":["paths/~1prescriptions/post/requestBody/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrescriptionInput","exampleIds":["paths/~1prescriptions/post/requestBody/content/application~1json/examples/default"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1prescriptions/post/responses/201/content/application~1json/examples/default"]}},"schemaId":"schema_7","exampleIds":["paths/~1prescriptions/post/responses/201/content/application~1json/examples/default"]},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/400/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/400/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/401/content/application~1json/examples/default"]},{"code":"422","description":"Invalid request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1prescriptions/post/responses/422/content/application~1json/examples/default"]}},"schemaId":"schema_6","exampleIds":["paths/~1prescriptions/post/responses/422/content/application~1json/examples/default"]}],"pointer":"/paths/~1prescriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_7","exampleIds":["paths/~1prescriptions/post/responses/201/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1prescriptions/post/responses/201/content/application~1json/examples/default"]}}},{"code":"400","schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/400/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/400/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions/post/responses/401/content/application~1json/examples/default"]}}},{"code":"422","schemaId":"schema_6","exampleIds":["paths/~1prescriptions/post/responses/422/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1prescriptions/post/responses/422/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/createprescription"}],"panels":[]}]},"httpPath":"/prescriptions"},{"label":"Get a prescription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/prescriptions/getprescription","routeSlug":"/intake-api/openapi/prescriptions/getprescription","metadata":{"seo":{"title":"Get a prescription","description":"Get a prescription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrescription","name":"Get a prescription","isWebhook":false,"pointer":"/paths/~1prescriptions~1{external_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a prescription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:prescriptions:read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1prescriptions~1{external_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/prescriptions/{external_id}","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[{"name":"external_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:prescriptions:read"]}],"responseCodes":["200","401","404"],"pointer":"/prescriptions/{external_id}","href":"prescriptions/getprescription","openApiOperationId":"getPrescription","summary":"Get a prescription","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:prescriptions:read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/404/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/404/content/application~1json/examples/default"]}],"pointer":"/paths/~1prescriptions~1{external_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/get/responses/404/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/getprescription"}],"panels":[]}]},"httpPath":"/prescriptions/{external_id}"},{"label":"Cancel a prescription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/intake-api/openapi/prescriptions/cancelprescription","routeSlug":"/intake-api/openapi/prescriptions/cancelprescription","metadata":{"seo":{"title":"Cancel a prescription","description":"Cancel a prescription"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelPrescription","name":"Cancel a prescription","isWebhook":false,"pointer":"/paths/~1prescriptions~1{external_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a prescription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]}]},{"schemes":[{"name":"OAuth2","scopes":["intake_api:prescriptions:write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"external_id","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1prescriptions~1{external_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/prescriptions/{external_id}","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"parameters":{"path":[{"name":"external_id","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}],"scopes":["intake_api:prescriptions:write"]}],"responseCodes":["200","401","404"],"pointer":"/prescriptions/{external_id}","href":"prescriptions/cancelprescription","openApiOperationId":"cancelPrescription","summary":"Cancel a prescription","securityGroups":[{"BearerAuth":[]},{"OAuth2":["intake_api:prescriptions:write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/200/content/application~1json/examples/default"]}},"schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/200/content/application~1json/examples/default"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/401/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/401/content/application~1json/examples/default"]},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/404/content/application~1json/examples/default"]}},"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/404/content/application~1json/examples/default"]}],"pointer":"/paths/~1prescriptions~1{external_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/200/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/200/content/application~1json/examples/default"]}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/401/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/401/content/application~1json/examples/default"]}}},{"code":"404","schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/404/content/application~1json/examples/default"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1prescriptions~1{external_id}/delete/responses/404/content/application~1json/examples/default"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/prescriptions/cancelprescription"}],"panels":[]}]},"httpPath":"/prescriptions/{external_id}"}],"content":{"contentType":"group","meta":{"name":"Prescriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prescriptions","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/prescriptions","summary":"Send a prescription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/prescriptions/createprescription","deprecated":false},{"title":"/prescriptions/{external_id}","summary":"Get a prescription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/prescriptions/getprescription","deprecated":false},{"title":"/prescriptions/{external_id}","summary":"Cancel a prescription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/prescriptions/cancelprescription","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ErrorMap":{"id":"components/schemas/ErrorMap","kind":"json-schema","title":"ErrorMap","data":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"components/schemas/CollectionMeta":{"id":"components/schemas/CollectionMeta","kind":"json-schema","title":"CollectionMeta","data":{"type":"object","properties":{"iterator":{"type":"string","nullable":true},"limit":{"type":"integer"},"done":{"type":"boolean"}},"required":["iterator","limit","done"]}},"components/schemas/Patient":{"id":"components/schemas/Patient","kind":"json-schema","title":"Patient","data":{"type":"object","properties":{"first_name":{"type":"string"},"middle_name":{"type":"string","nullable":true},"last_name":{"type":"string"},"dob":{"type":"string","format":"date"},"gender":{"type":"string","enum":["M","F","N","U"]},"primary_phone":{"type":"string"},"email":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/Address"}},"required":["first_name","last_name","dob","gender","primary_phone","address"]}},"components/schemas/Allergy":{"id":"components/schemas/Allergy","kind":"json-schema","title":"Allergy","data":{"type":"object","properties":{"source_of_information":{"type":"string","enum":["C","P","O"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates where the sender received the allergy information if known. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for patient or patient representative or personal health record (PHR), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for clinician or provider, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"O"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for other source"},"children":[]}]}]}]},"effective_date":{"type":"string","format":"date","nullable":true},"adverse_event":{"$ref":"#/components/schemas/AllergyAdverseEvent"},"drug_product":{"$ref":"#/components/schemas/AllergyDrugProduct"},"severity":{"$ref":"#/components/schemas/AllergySeverity"}},"required":["source_of_information","adverse_event","drug_product"]}},"components/schemas/AllergyAdverseEvent":{"id":"components/schemas/AllergyAdverseEvent","kind":"json-schema","title":"AllergyAdverseEvent","data":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string","description":"SNOMED code for the adverse event.","nullable":true}},"required":["text"]}},"components/schemas/AllergyDrugProduct":{"id":"components/schemas/AllergyDrugProduct","kind":"json-schema","title":"AllergyDrugProduct","data":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string","description":"SNOMED code for the drug product.","nullable":true}},"required":["text"]}},"components/schemas/AllergySeverity":{"id":"components/schemas/AllergySeverity","kind":"json-schema","title":"AllergySeverity","data":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string","description":"SNOMED code for the severity.","nullable":true}},"required":["text"]}},"components/schemas/Prescription":{"id":"components/schemas/Prescription","kind":"json-schema","title":"Prescription","data":{"type":"object","properties":{"external_id":{"type":"string","description":"Unique identifier for this prescription, provided by the prescriber"},"written_date":{"type":"string","format":"date"},"effective_date":{"type":"string","format":"date","nullable":true},"number_of_refills":{"type":"integer"},"substitutions":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NCPDP Dispense As Written/Product Selection Code. E.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Product Selection Indicated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Substitution Not Allowed by Prescriber"},"children":[]}]}]}]},"sig_text":{"type":"string"},"note":{"type":"string"},"cancellation_requested_at":{"type":"string","format":"date-time","nullable":true,"description":"A non-null value for this field indicates that the script has been flagged for Gifthealth to cancel the prescription as soon as possible."},"patient":{"$ref":"#/components/schemas/Patient"},"medication":{"$ref":"#/components/schemas/Medication"},"prescriber":{"$ref":"#/components/schemas/Prescriber"},"pharmacy":{"$ref":"#/components/schemas/Pharmacy"},"allergies":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An empty array indicates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Known Allergies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the patient's allergy history is unknown, this will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/Allergy"}},"originating_entity":{"type":"string"}},"required":["external_id","written_date","number_of_refills","substitutions","sig_text","patient","prescriber","medication","pharmacy","allergies"]}},"components/schemas/Medication":{"id":"components/schemas/Medication","kind":"json-schema","title":"Medication","data":{"type":"object","properties":{"name":{"type":"string"},"ndc":{"type":"string","description":"NDC code for a medication dispensed by Gifthealth.","enum":["00002015204","00002024304","00002121404","00002134004","00002142304","00002200204","00002356611","00002355511","00002354411","00002353311","00002352211","00002351111","00002417831","00002450331","00002479431","00002480331","00002483931","00002495331"]},"quantity":{"type":"string","format":"decimal"},"quantity_unit_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NCPDP Quantity Unit of Measure Code. E.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C28254"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Milliliters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C64933"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Each"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C120216"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pen Needle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Ensure that the code is appropriate for the prescription."},"children":[]}]}]}],"enum":["C64933","C28254","C120216","C48542","C48480","C48477","C38046","C97717","C48551"]},"days_supply":{"type":"integer","nullable":true},"diagnosis":{"$ref":"#/components/schemas/Diagnosis"}},"required":["name","ndc","quantity","quantity_unit_code"]}},"components/schemas/Diagnosis":{"id":"components/schemas/Diagnosis","kind":"json-schema","title":"Diagnosis","data":{"type":"object","properties":{"primary_icd10_code":{"type":"string"},"primary_icd10_description":{"type":"string"},"secondary_icd10_code":{"type":"string","nullable":true},"secondary_icd10_description":{"type":"string","nullable":true}},"required":["primary_icd10_code","primary_icd10_description"]}},"components/schemas/Prescriber":{"id":"components/schemas/Prescriber","kind":"json-schema","title":"Prescriber","data":{"type":"object","properties":{"first_name":{"type":"string"},"middle_name":{"type":"string","nullable":true},"last_name":{"type":"string"},"npi":{"type":"string"},"primary_phone":{"type":"string"},"fax":{"type":"string","nullable":true},"address":{"$ref":"#/components/schemas/Address"}},"required":["first_name","last_name","npi","primary_phone","address"]}},"components/schemas/Pharmacy":{"id":"components/schemas/Pharmacy","kind":"json-schema","title":"Pharmacy","data":{"type":"object","properties":{"npi":{"type":"string"},"ncpdpid":{"type":"string"},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"primary_phone":{"type":"string"},"fax":{"type":"string","nullable":true}},"required":["npi","ncpdpid","name","address","primary_phone"]}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"state":{"type":"string","description":"Two-letter state abbreviation. Fifty US states and DC only."},"zip":{"type":"string","description":"Five-digit ZIP code."}},"required":["address1","city","state","zip"]}},"components/schemas/PublishedEvent":{"id":"components/schemas/PublishedEvent","kind":"json-schema","title":"PublishedEvent","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","enum":["accepted","rejected","ordered","dispensed","delivered","transferred","refunded","cancelled"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the event that occurred. Additional information specific to each event is available in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"prescription_identity":{"$ref":"#/components/schemas/PrescriptionIdentity"},"pharmacy_npi":{"type":"string","description":"The NPI of the Gifthealth pharmacy that is managing this prescription."},"occurred_at":{"type":"string","format":"date_time","description":"The time that the event happened."},"api_version":{"type":"string","description":"The version of the API when this event was published. This is specified by the subscription under which the event was published. To get events for a newer API version, cancel the existing subscription for the script and then create a new one through the newer API version."},"subscription_id":{"type":"string","description":"The subscription that triggered this event to be published."},"payload":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the event. This will be an empty object ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") if there is no additional information for the event type."},"children":[]}]}]}],"anyOf":[{"$ref":"#/components/schemas/EventRejectedPayload"},{"$ref":"#/components/schemas/EventOrderedPayload"},{"$ref":"#/components/schemas/EventDispensedPayload"},{"$ref":"#/components/schemas/EventDeliveredPayload"},{"$ref":"#/components/schemas/EventTransferredPayload"},{"$ref":"#/components/schemas/EventRefundedPayload"},{"$ref":"#/components/schemas/EventCancelledPayload"}]}},"required":["id","prescription_identity","name","api_version","pharmacy_npi","occurred_at","subscription_id","payload"]}},"components/schemas/PrescriptionIdentity":{"id":"components/schemas/PrescriptionIdentity","kind":"json-schema","title":"PrescriptionIdentity","data":{"type":"object","description":"This information should be used to match events to prescriptions as they are read from the events endpoint.","properties":{"patient_first_name":{"type":"string"},"patient_last_name":{"type":"string"},"patient_state":{"type":"string"},"patient_dob":{"type":"string","format":"date"},"erx_message_id":{"type":"string","nullable":true},"prescriber_npi":{"type":"string"},"written_date":{"type":"string","format":"date"},"drug_ndc":{"type":"string"}},"required":["patient_first_name","patient_last_name","patient_state","patient_dob","prescriber_npi","written_date","drug_ndc"]}},"components/schemas/EventRejectedPayload":{"id":"components/schemas/EventRejectedPayload","kind":"json-schema","title":"EventRejectedPayload","data":{"type":"object","properties":{"rejection_reasons":{"type":"array","items":{"type":"string"}}},"required":["rejection_reasons"]}},"components/schemas/EventOrderedPayload":{"id":"components/schemas/EventOrderedPayload","kind":"json-schema","title":"EventOrderedPayload","data":{"type":"object","properties":{"amount_paid_cents":{"type":"integer"},"amount_paid_currency":{"type":"string"},"rx_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for the prescription that was ordered, unique per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pharmacy_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fill_number":{"type":"integer","description":"The fill number of the fill that was ordered."}},"required":["amount_paid_cents","amount_paid_currency","rx_number","fill_number"]}},"components/schemas/EventDispensedPayload":{"id":"components/schemas/EventDispensedPayload","kind":"json-schema","title":"EventDispensedPayload","data":{"type":"object","properties":{"shipping_carrier":{"type":"string"},"shipping_tracking_number":{"type":"string"},"rx_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for the prescription that was dispensed, unique per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pharmacy_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fill_number":{"type":"integer","description":"The fill number of the fill that was dispensed."}},"required":["shipping_carrier","shipping_tracking_number","rx_number","fill_number"]}},"components/schemas/EventDeliveredPayload":{"id":"components/schemas/EventDeliveredPayload","kind":"json-schema","title":"EventDeliveredPayload","data":{"type":"object","properties":{"shipping_carrier":{"type":"string"},"shipping_tracking_number":{"type":"string"},"rx_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for the prescription that was delivered, unique per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pharmacy_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fill_number":{"type":"integer","description":"The fill number of the fill that was delivered."}},"required":["shipping_carrier","shipping_tracking_number","rx_number","fill_number"]}},"components/schemas/EventTransferredPayload":{"id":"components/schemas/EventTransferredPayload","kind":"json-schema","title":"EventTransferredPayload","data":{"type":"object","properties":{"pharmacy_name":{"type":"string","description":"Name of the pharmacy the prescription was transferred to."},"pharmacy_npi":{"type":"string","nullable":true,"description":"NPI of the pharmacy the prescription was transferred to."},"pharmacy_phone_number":{"type":"string","nullable":true,"description":"Phone number of the pharmacy the prescription was transferred to."},"rx_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for the prescription that was transferred, unique per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pharmacy_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fill_number":{"type":"integer","description":"The fill number of the fill that was transferred."}},"required":["pharmacy_name","rx_number","fill_number"]}},"components/schemas/EventRefundedPayload":{"id":"components/schemas/EventRefundedPayload","kind":"json-schema","title":"EventRefundedPayload","data":{"type":"object","properties":{"amount_cents":{"type":"integer","description":"The refunded amount in cents."},"amount_currency":{"type":"string","description":"The currency of the refunded amount."},"reason":{"type":"string","nullable":true,"description":"The reason for the refund."},"rx_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for the prescription that was refunded, unique per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pharmacy_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fill_number":{"type":"integer","description":"The fill number of the fill that was refunded."}},"required":["amount_cents","amount_currency","rx_number","fill_number"]}},"components/schemas/EventCancelledPayload":{"id":"components/schemas/EventCancelledPayload","kind":"json-schema","title":"EventCancelledPayload","data":{"type":"object","properties":{"rx_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier for the prescription that was cancelled, unique per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pharmacy_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["rx_number"]}},"components/schemas/Subscription":{"id":"components/schemas/Subscription","kind":"json-schema","title":"Subscription","data":{"type":"object","properties":{"id":{"type":"string"},"backfill_previous_events":{"type":"boolean","nullable":true,"default":true},"api_version":{"type":"string"},"cancelled_at":{"type":"string","format":"date_time","nullable":true},"prescription_identity":{"$ref":"#/components/schemas/PrescriptionIdentity"}},"required":["id","api_version","backfill_previous_events","prescription_identity"]}},"components/schemas/PrescriptionIdentityInput":{"id":"components/schemas/PrescriptionIdentityInput","kind":"json-schema","title":"PrescriptionIdentityInput","data":{"type":"object","description":"Details are used to match your prescriptions to Gifthealth prescriptions. This information will be included and sent back to you for all events so you can match up the events to scripts in your system.","properties":{"patient_first_name":{"type":"string"},"patient_last_name":{"type":"string"},"patient_state":{"type":"string"},"patient_dob":{"type":"string","format":"date"},"erx_message_id":{"type":"string","nullable":true,"description":"Unique identifier for the eRx sent to Gifthealth. Although optional, including this value allows for a more exact match between Gifthealth events and your prescriptions."},"prescriber_npi":{"type":"string","description":"10-digit National Provider Identifier (NPI) for the prescriber."},"written_date":{"type":"string","format":"date"},"drug_ndc":{"type":"string"}},"required":["patient_first_name","patient_last_name","patient_state","patient_dob","prescriber_npi","written_date","drug_ndc"]}},"components/schemas/SubscriptionInput":{"id":"components/schemas/SubscriptionInput","kind":"json-schema","title":"SubscriptionInput","data":{"type":"object","properties":{"subscription":{"type":"object","properties":{"backfill_previous_events":{"type":"boolean","nullable":true,"default":true,"description":"Setting this to true will publish any historic events for the prescription if the Subscription is created after the prescription already has events logged."},"prescription_identity":{"$ref":"#/components/schemas/PrescriptionIdentityInput"}},"required":["prescription_identity"]}},"required":["subscription"]}},"components/schemas/PrescriptionInput":{"id":"components/schemas/PrescriptionInput","kind":"json-schema","title":"PrescriptionInput","data":{"type":"object","properties":{"prescription":{"type":"object","properties":{"external_id":{"type":"string","description":"Your unique identifier for this prescription. You will use this value to query or cancel individual prescriptions."},"written_date":{"type":"string","format":"date"},"effective_date":{"type":"string","format":"date","nullable":true},"number_of_refills":{"type":"integer"},"substitutions":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NCPDP Dispense As Written/Product Selection Code. E.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Product Selection Indicated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Substitution Not Allowed by Prescriber"},"children":[]}]}]}]},"sig_text":{"type":"string"},"note":{"type":"string"},"patient":{"$ref":"#/components/schemas/PatientInput"},"medication":{"$ref":"#/components/schemas/MedicationInput"},"prescriber":{"$ref":"#/components/schemas/PrescriberInput"},"pharmacy":{"$ref":"#/components/schemas/PharmacyInput"},"allergies":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An empty array indicates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No Known Allergies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the patient's allergy history is unknown, pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit this key."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/AllergyInput"}},"originating_entity":{"type":"string"}},"required":["external_id","written_date","number_of_refills","substitutions","sig_text","patient","medication","prescriber","pharmacy"]}},"required":["prescription"]}},"components/schemas/PatientInput":{"id":"components/schemas/PatientInput","kind":"json-schema","title":"PatientInput","data":{"type":"object","properties":{"first_name":{"type":"string"},"middle_name":{"type":"string","nullable":true},"last_name":{"type":"string"},"dob":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patient date of birth, in format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"gender":{"type":"string","enum":["M","F","N","U"],"description":"Patient gender assigned at birth."},"address":{"$ref":"#/components/schemas/AddressInput"},"primary_phone":{"type":"string","description":"Primary contact phone number for the patient. US phone numbers only."},"email":{"type":"string","nullable":true}},"required":["first_name","last_name","dob","gender","primary_phone","address"]}},"components/schemas/AllergyInput":{"id":"components/schemas/AllergyInput","kind":"json-schema","title":"AllergyInput","data":{"type":"object","properties":{"source_of_information":{"type":"string","enum":["C","P","O"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates where the sender received the allergy information if known. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for patient or patient representative or personal health record (PHR), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for clinician or provider, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"O"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for other source"},"children":[]}]}]}]},"effective_date":{"type":"string","format":"date","nullable":true},"adverse_event":{"$ref":"#/components/schemas/AllergyAdverseEventInput"},"drug_product":{"$ref":"#/components/schemas/AllergyDrugProductInput"},"severity":{"$ref":"#/components/schemas/AllergySeverityInput"}},"required":["source_of_information","adverse_event","drug_product"]}},"components/schemas/AllergyAdverseEventInput":{"id":"components/schemas/AllergyAdverseEventInput","kind":"json-schema","title":"AllergyAdverseEventInput","data":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string","description":"SNOMED code for the adverse event.","nullable":true}},"required":["text"]}},"components/schemas/AllergyDrugProductInput":{"id":"components/schemas/AllergyDrugProductInput","kind":"json-schema","title":"AllergyDrugProductInput","data":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string","description":"SNOMED code for the drug product.","nullable":true}},"required":["text"]}},"components/schemas/AllergySeverityInput":{"id":"components/schemas/AllergySeverityInput","kind":"json-schema","title":"AllergySeverityInput","data":{"type":"object","properties":{"text":{"type":"string"},"code":{"type":"string","description":"SNOMED code for the severity.","nullable":true}},"required":["text"]}},"components/schemas/AddressInput":{"id":"components/schemas/AddressInput","kind":"json-schema","title":"AddressInput","data":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string","nullable":true},"city":{"type":"string"},"state":{"type":"string","description":"Two-letter state abbreviation. Fifty US states and DC only."},"zip":{"type":"string","description":"Five-digit ZIP code."}},"required":["address1","city","state","zip"]}},"components/schemas/PrescriberInput":{"id":"components/schemas/PrescriberInput","kind":"json-schema","title":"PrescriberInput","data":{"type":"object","properties":{"first_name":{"type":"string"},"middle_name":{"type":"string","nullable":true},"last_name":{"type":"string"},"suffix":{"type":"string","nullable":true},"npi":{"type":"string","description":"10-digit National Provider Identifier (NPI) for the prescriber."},"primary_phone":{"type":"string","description":"Primary phone number for the prescriber. US phone numbers only."},"fax":{"type":"string","nullable":true,"description":"Fax number for the prescriber. US phone numbers only."},"address":{"$ref":"#/components/schemas/AddressInput"}},"required":["first_name","last_name","npi","primary_phone","address"]}},"components/schemas/PharmacyInput":{"id":"components/schemas/PharmacyInput","kind":"json-schema","title":"PharmacyInput","data":{"type":"object","properties":{"npi":{"type":"string","enum":["1689411712"],"description":"10-digit National Provider Identifier (NPI) for the receiving pharmacy for this prescription. Must be a valid NPI for a Gifthealth-managed pharmacy."},"ncpdpid":{"type":"string","enum":["3692539"],"description":"NCPDP ID for the receiving pharmacy for this prescription. Must be a valid NCPDP ID for a Gifthealth-managed pharmacy."},"name":{"type":"string"},"address":{"$ref":"#/components/schemas/AddressInput"},"primary_phone":{"type":"string","description":"Primary contact phone number for the receiving pharmacy. US phone numbers only."},"fax":{"type":"string","nullable":true,"description":"Fax number for the receiving pharmacy. US phone numbers only."}},"required":["npi","ncpdpid","name","address","primary_phone"]}},"components/schemas/DiagnosisInput":{"id":"components/schemas/DiagnosisInput","kind":"json-schema","title":"DiagnosisInput","data":{"type":"object","properties":{"primary_icd10_code":{"type":"string"},"primary_icd10_description":{"type":"string"},"secondary_icd10_code":{"type":"string","nullable":true},"secondary_icd10_description":{"type":"string","nullable":true}},"required":["primary_icd10_code","primary_icd10_description"]}},"components/schemas/MedicationInput":{"id":"components/schemas/MedicationInput","kind":"json-schema","title":"MedicationInput","data":{"type":"object","properties":{"name":{"type":"string"},"ndc":{"type":"string","description":"NDC code for a medication dispensed by Gifthealth.","enum":["00002015204","00002024304","00002121404","00002134004","00002142304","00002200204","00002356611","00002355511","00002354411","00002353311","00002352211","00002351111","00002417831","00002450331","00002479431","00002480331","00002483931","00002495331"]},"quantity":{"type":"string","format":"decimal"},"quantity_unit_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NCPDP Quantity Unit of Measure Code. E.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C28254"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Milliliters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C64933"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Each"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C120216"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Pen Needle"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", etc. Ensure that the code is appropriate for the prescription."},"children":[]}]}]}],"enum":["C64933","C28254","C120216","C48542","C48480","C48477","C38046","C97717","C48551"]},"days_supply":{"type":"integer","nullable":true},"diagnosis":{"$ref":"#/components/schemas/DiagnosisInput"}},"required":["name","ndc","quantity","quantity_unit_code"]}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/PublishedEvent"}},"meta":{"$ref":"#/components/schemas/CollectionMeta"}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"error":{"type":"string"}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/PublishedEvent"}}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","properties":{"subscription":{"$ref":"#/components/schemas/Subscription"}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/ErrorMap"}}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"object","properties":{"prescription":{"$ref":"#/components/schemas/Prescription"}}},"id":"schema_7"}},"exampleStore":{"paths/~1events/get/responses/200/content/application~1json/examples/default":{"value":{"events":[{"id":"3d839a57-ce1d-47f3-b8f3-3ebfc74601c2","api_version":"2024-12-10","name":"rejected","occurred_at":"2025-02-25T04:50:46Z","payload":{"rejection_reasons":["wrong_diagnosis","wrong_medication_form"]},"pharmacy_npi":"1689411712","prescription_identity":{"drug_ndc":"1234567890","erx_message_id":"123456789","patient_dob":"1980-01-01","patient_first_name":"Todd","patient_last_name":"Smith","patient_state":"CA","prescriber_npi":"1231231234","written_date":"2025-02-25"},"subscription_id":"3d839a57-ce1d-47f3-b8f3-3ebfc74601c2"}],"meta":{"limit":1,"iterator":"M2Q4MzlhNTctY2UxZC00N2YzLWI4ZjMtM2ViZmM3NDYwMWMy","done":true}},"key":"default","summary":"default","id":"paths/~1events/get/responses/200/content/application~1json/examples/default"},"paths/~1events/get/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1events/get/responses/401/content/application~1json/examples/default"},"paths/~1events~1{id}/get/responses/200/content/application~1json/examples/default":{"value":{"event":{"id":"3d839a57-ce1d-47f3-b8f3-3ebfc74601c2","api_version":"2024-12-10","name":"rejected","occurred_at":"2025-02-25T04:50:46Z","payload":{"rejection_reasons":["wrong_diagnosis","wrong_medication_form"]},"pharmacy_npi":"1689411712","prescription_identity":{"drug_ndc":"1234567890","erx_message_id":"123456789","patient_dob":"1980-01-01","patient_first_name":"Todd","patient_last_name":"Smith","patient_state":"CA","prescriber_npi":"1231231234","written_date":"2025-02-25"},"subscription_id":"3d839a57-ce1d-47f3-b8f3-3ebfc74601c2"}},"key":"default","summary":"default","id":"paths/~1events~1{id}/get/responses/200/content/application~1json/examples/default"},"paths/~1events~1{id}/get/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1events~1{id}/get/responses/401/content/application~1json/examples/default"},"paths/~1events~1{id}/get/responses/404/content/application~1json/examples/default":{"value":{"error":"Not found"},"key":"default","summary":"default","id":"paths/~1events~1{id}/get/responses/404/content/application~1json/examples/default"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/default":{"value":{"subscription":{"backfill_previous_events":true,"prescription_identity":{"erx_message_id":"123456789","patient_first_name":"Todd","patient_last_name":"Smith","patient_state":"CA","patient_dob":"1980-01-01","prescriber_npi":"123231321","written_date":"2025-02-25","drug_ndc":"1234567890"}}},"key":"default","summary":"Create a subscription","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/default"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/default":{"value":{"subscription":{"id":"ca101492-50c0-4c2f-9014-2dd926183f75","api_version":"2024-12-10","backfill_previous_events":true,"cancelled_at":null,"prescription_identity":{"drug_ndc":"1234567890","erx_message_id":"123456789","patient_dob":"1980-01-01","patient_first_name":"Todd","patient_last_name":"Smith","patient_state":"CA","prescriber_npi":"123231321","written_date":"2025-02-25"}}},"key":"default","summary":"default","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/default"},"paths/~1subscriptions/post/responses/400/content/application~1json/examples/default":{"value":{"error":"Bad request"},"key":"default","summary":"default","id":"paths/~1subscriptions/post/responses/400/content/application~1json/examples/default"},"paths/~1subscriptions/post/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1subscriptions/post/responses/401/content/application~1json/examples/default"},"paths/~1subscriptions/post/responses/422/content/application~1json/examples/default":{"value":{"errors":{"prescription_identity":["is invalid"],"prescription_identity.patient_first_name":["can't be blank"],"prescription_identity.patient_dob":["can't be blank"]}},"key":"default","summary":"default","id":"paths/~1subscriptions/post/responses/422/content/application~1json/examples/default"},"paths/~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/default":{"value":{"subscription":{"id":"3d839a57-ce1d-47f3-b8f3-3ebfc74601c2","api_version":"2024-12-10","backfill_previous_events":true,"cancelled_at":null,"prescription_identity":{"drug_ndc":"1234567890","erx_message_id":"123456789","patient_dob":"1980-01-01","patient_first_name":"Todd","patient_last_name":"Smith","patient_state":"CA","prescriber_npi":"1231231234","written_date":"2025-02-25"}}},"key":"default","summary":"default","id":"paths/~1subscriptions~1{id}/get/responses/200/content/application~1json/examples/default"},"paths/~1subscriptions~1{id}/get/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1subscriptions~1{id}/get/responses/401/content/application~1json/examples/default"},"paths/~1subscriptions~1{id}/get/responses/404/content/application~1json/examples/default":{"value":{"error":"Not found"},"key":"default","summary":"default","id":"paths/~1subscriptions~1{id}/get/responses/404/content/application~1json/examples/default"},"paths/~1subscriptions~1{id}/delete/responses/200/content/application~1json/examples/default":{"value":{"subscription":{"id":"3d839a57-ce1d-47f3-b8f3-3ebfc74601c2","api_version":"2024-12-10","backfill_previous_events":true,"cancelled_at":"2024-12-09T00:00:00Z","prescription_identity":{"drug_ndc":"1234567890","erx_message_id":"123456789","patient_dob":"1980-01-01","patient_first_name":"Todd","patient_last_name":"Smith","patient_state":"CA","prescriber_npi":"1231231234","written_date":"2025-02-25"}}},"key":"default","summary":"default","id":"paths/~1subscriptions~1{id}/delete/responses/200/content/application~1json/examples/default"},"paths/~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1subscriptions~1{id}/delete/responses/401/content/application~1json/examples/default"},"paths/~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/default":{"value":{"error":"Not found"},"key":"default","summary":"default","id":"paths/~1subscriptions~1{id}/delete/responses/404/content/application~1json/examples/default"},"paths/~1prescriptions/post/requestBody/content/application~1json/examples/default":{"value":{"prescription":{"external_id":"f1b3b1a2-361a-40b3-8089-5a235122e023","written_date":"2024-12-10","number_of_refills":3,"substitutions":1,"sig_text":"Inject 0.5 ml subcutaneously every week","note":"Please include a syringe","originating_entity":"Telehealth Co","medication":{"name":"ZEPBOUND 2.5MG / 0.5ML SOLUTION","ndc":"00002015204","quantity":"2.0","quantity_unit_code":"C28254","days_supply":30,"diagnosis":{"primary_icd10_code":"J45.909","primary_icd10_description":"Asthma, unspecified, uncomplicated"}},"prescriber":{"first_name":"Jane","last_name":"Smith","npi":"1234567890","primary_phone":"513-555-7390","address":{"address1":"456 Elm St","city":"Springfield","state":"IL","zip":"62701"}},"patient":{"first_name":"John","middle_name":"J","last_name":"Doe","dob":"1980-01-01","gender":"M","address":{"address1":"123 Main St","address2":"Apt 1","city":"Springfield","state":"IL","zip":"62701"},"primary_phone":"555-555-5555","email":"test@example.com"},"pharmacy":{"npi":"1689411712","ncpdpid":"3692539","name":"Gifthealth dba LillyDirect Self Pay Pharmacy","primary_phone":"833-432-4322","address":{"address1":"4343 EQUITY DR","address2":"STE A","city":"COLUMBUS","state":"OH","zip":"43228"}},"allergies":[{"source_of_information":"C","effective_date":"2017-07-03","adverse_event":{"text":"Drug Allergy","code":"416098002"},"drug_product":{"text":"ACETAMINOPHEN","code":"362O9ITL9D"},"severity":{"text":"Mild","code":"255604002"}}]}},"key":"default","summary":"Send a prescription","id":"paths/~1prescriptions/post/requestBody/content/application~1json/examples/default"},"paths/~1prescriptions/post/responses/201/content/application~1json/examples/default":{"value":{"prescription":{"external_id":"f1b3b1a2-361a-40b3-8089-5a235122e023","allergies":[{"adverse_event":{"code":"416098002","text":"Drug Allergy"},"drug_product":{"code":"362O9ITL9D","text":"ACETAMINOPHEN"},"effective_date":"2017-07-03","severity":{"code":"255604002","text":"Mild"},"source_of_information":"C"}],"cancellation_requested_at":null,"medication":{"days_supply":30,"diagnosis":{"primary_icd10_code":"J45.909","primary_icd10_description":"Asthma, unspecified, uncomplicated","secondary_icd10_code":null,"secondary_icd10_description":null},"name":"ZEPBOUND 2.5MG / 0.5ML SOLUTION","ndc":"00002015204","quantity":"2.0","quantity_unit_code":"C28254"},"note":"Please include a syringe","number_of_refills":3,"originating_entity":"Telehealth Co","patient":{"address":{"address1":"123 Main St","address2":"Apt 1","city":"Springfield","state":"IL","zip":"62701"},"dob":"1980-01-01","email":"test@example.com","first_name":"John","gender":"M","last_name":"Doe","middle_name":"J","primary_phone":"+15555555555"},"pharmacy":{"address":{"address1":"4343 EQUITY DR","address2":"STE A","city":"COLUMBUS","state":"OH","zip":"43228"},"fax":null,"name":"Gifthealth dba LillyDirect Self Pay Pharmacy","ncpdpid":"3692539","npi":"1689411712","primary_phone":"+18334324322"},"prescriber":{"address":{"address1":"456 Elm St","address2":null,"city":"Springfield","state":"IL","zip":"62701"},"fax":null,"first_name":"Jane","last_name":"Smith","middle_name":null,"npi":"1234567890","primary_phone":"+15135557390"},"sig_text":"Inject 0.5 ml subcutaneously every week","substitutions":1,"written_date":"2024-12-10"}},"key":"default","summary":"default","id":"paths/~1prescriptions/post/responses/201/content/application~1json/examples/default"},"paths/~1prescriptions/post/responses/400/content/application~1json/examples/default":{"value":{"error":"Bad request"},"key":"default","summary":"default","id":"paths/~1prescriptions/post/responses/400/content/application~1json/examples/default"},"paths/~1prescriptions/post/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1prescriptions/post/responses/401/content/application~1json/examples/default"},"paths/~1prescriptions/post/responses/422/content/application~1json/examples/default":{"value":{"errors":{"medication":["is invalid"],"patient":["can't be blank"],"prescriber":["can't be blank"],"pharmacy":["can't be blank"],"medication.quantity":["can't be blank"]}},"key":"default","summary":"default","id":"paths/~1prescriptions/post/responses/422/content/application~1json/examples/default"},"paths/~1prescriptions~1{external_id}/get/responses/200/content/application~1json/examples/default":{"value":{"prescription":{"external_id":"80efb1a2-361a-40b3-8089-5a235122e023","allergies":[{"adverse_event":{"code":"416098002","text":"Drug Allergy"},"drug_product":{"code":"362O9ITL9D","text":"ACETAMINOPHEN"},"effective_date":"2017-07-03","severity":{"code":"255604002","text":"Mild"},"source_of_information":"C"}],"cancellation_requested_at":null,"medication":{"days_supply":30,"diagnosis":{"primary_icd10_code":"J45.909","primary_icd10_description":"Asthma, unspecified, uncomplicated","secondary_icd10_code":null,"secondary_icd10_description":null},"name":"ZEPBOUND 2.5MG / 0.5ML SOLUTION","ndc":"00002015204","quantity":"2.0","quantity_unit_code":"C28254"},"note":"Please include a syringe","number_of_refills":3,"originating_entity":"Telehealth Co","patient":{"address":{"address1":"123 Main St","address2":"Apt 1","city":"Springfield","state":"IL","zip":"62701"},"dob":"1980-01-01","email":"test@example.com","first_name":"John","gender":"M","last_name":"Doe","middle_name":"Q","primary_phone":"+15135557890"},"pharmacy":{"address":{"address1":"4343 EQUITY DR","address2":"STE A","city":"COLUMBUS","state":"OH","zip":"43228"},"fax":null,"name":"Gifthealth dba LillyDirect Self Pay Pharmacy","ncpdpid":"3692539","npi":"1689411712","primary_phone":"+18334324322"},"prescriber":{"address":{"address1":"456 Elm St","address2":null,"city":"Springfield","state":"IL","zip":"62701"},"fax":null,"first_name":"Jane","last_name":"Smith","middle_name":null,"npi":"1234567890","primary_phone":"+15135557390"},"sig_text":"Inject 0.5 ml subcutaneously every week","substitutions":1,"written_date":"2024-12-28"}},"key":"default","summary":"default","id":"paths/~1prescriptions~1{external_id}/get/responses/200/content/application~1json/examples/default"},"paths/~1prescriptions~1{external_id}/get/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1prescriptions~1{external_id}/get/responses/401/content/application~1json/examples/default"},"paths/~1prescriptions~1{external_id}/get/responses/404/content/application~1json/examples/default":{"value":{"error":"Not found"},"key":"default","summary":"default","id":"paths/~1prescriptions~1{external_id}/get/responses/404/content/application~1json/examples/default"},"paths/~1prescriptions~1{external_id}/delete/responses/200/content/application~1json/examples/default":{"value":{"prescription":{"external_id":"80efb1a2-361a-40b3-8089-5a235122e023","allergies":[{"adverse_event":{"code":"416098002","text":"Drug Allergy"},"drug_product":{"code":"362O9ITL9D","text":"ACETAMINOPHEN"},"effective_date":"2017-07-03","severity":{"code":"255604002","text":"Mild"},"source_of_information":"C"}],"cancellation_requested_at":"2024-12-09T00:00:00Z","medication":{"days_supply":30,"diagnosis":{"primary_icd10_code":"J45.909","primary_icd10_description":"Asthma, unspecified, uncomplicated","secondary_icd10_code":null,"secondary_icd10_description":null},"name":"ZEPBOUND 2.5MG / 0.5ML SOLUTION","ndc":"00002015204","quantity":"2.0","quantity_unit_code":"C28254"},"note":"Please include a syringe","number_of_refills":3,"originating_entity":"Telehealth Co","patient":{"address":{"address1":"123 Main St","address2":"Apt 1","city":"Springfield","state":"IL","zip":"62701"},"dob":"1980-01-01","email":"test@example.com","first_name":"John","gender":"M","last_name":"Doe","middle_name":"Q","primary_phone":"+15135557890"},"pharmacy":{"address":{"address1":"4343 EQUITY DR","address2":"STE A","city":"COLUMBUS","state":"OH","zip":"43228"},"fax":null,"name":"Gifthealth dba LillyDirect Self Pay Pharmacy","ncpdpid":"3692539","npi":"1689411712","primary_phone":"+18334324322"},"prescriber":{"address":{"address1":"456 Elm St","address2":null,"city":"Springfield","state":"IL","zip":"62701"},"fax":null,"first_name":"Jane","last_name":"Smith","middle_name":null,"npi":"1234567890","primary_phone":"+15135557390"},"sig_text":"Inject 0.5 ml subcutaneously every week","substitutions":1,"written_date":"2024-12-28"}},"key":"default","summary":"default","id":"paths/~1prescriptions~1{external_id}/delete/responses/200/content/application~1json/examples/default"},"paths/~1prescriptions~1{external_id}/delete/responses/401/content/application~1json/examples/default":{"value":{"error":"Unauthorized"},"key":"default","summary":"default","id":"paths/~1prescriptions~1{external_id}/delete/responses/401/content/application~1json/examples/default"},"paths/~1prescriptions~1{external_id}/delete/responses/404/content/application~1json/examples/default":{"value":{"error":"Not found"},"key":"default","summary":"default","id":"paths/~1prescriptions~1{external_id}/delete/responses/404/content/application~1json/examples/default"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded bearer token of value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_key:api_secret"},"children":[]}]}]}]},"OAuth2":{"id":"OAuth2","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token from the token URL with a form-encoded body of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grant_type=client_credentials"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the space-separated scopes your calls need (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"intake_api:prescriptions:write intake_api:events:read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), authenticating with your client ID and secret over HTTP Basic. Send the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a bearer token. Each operation names the scope it requires, and a token without that scope gets a 403. Request a new token once "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" seconds have passed."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://app.gifthealth.com/oauth/token","scopes":{"intake_api:prescriptions:read":"Get prescriptions","intake_api:prescriptions:write":"Send and cancel prescriptions","intake_api:subscriptions:read":"Get subscriptions","intake_api:subscriptions:write":"Create and cancel subscriptions","intake_api:events:read":"Get events"}}}}},"specVersion":"3.0.1","servers":[{"url":"https://{defaultHost}/intake_api/2024-12-10","variables":{"defaultHost":{"default":"app.gifthealth.com"}}}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/intake-api/@2024-12-10/openapi.json?download"},{"url":"/_bundle/intake-api/@2024-12-10/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Intake API","description":"This API allows prescribers to send new prescriptions to Gifthealth to be filled. This API is intended only for use by prescribers and their software vendors.\n\n{% admonition type=\"info\" %}\n  In order to use this API, you must have an active agreement and/or attestation with Gifthealth. If you are interested in using this API, please contact Gifthealth.\n{% /admonition %}\n"}},"baseSlug":"/intake-api/openapi","routesMapping":{}}