{"items":[{"type":"link","label":"Pharmacy API","link":"/apis","routeSlug":"/apis","content":{"contentType":"overview","meta":{"name":"Pharmacy API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/apis/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/apis/index.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":"/_mock/apis","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Pharmacy API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"API reference for pharmacies to integrate with PHIL."}],"sectionId":"/apis"}],"sectionId":"/apis"}]}]}},{"type":"group","label":"Partner APIs","link":"/apis/partner-apis","routeSlug":"/apis/partner-apis","items":[{"label":"Prescription Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/partner-apis/rx-transfer","routeSlug":"/apis/partner-apis/rx-transfer","metadata":{"seo":{"title":"Prescription Transfer","description":"PHIL will perform a prescription transfer request to a partner pharmacy to transfer ownership of a prescription. This endpoint specifies the request we will send and the response that we expect to get back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rx-transfer","name":"Prescription Transfer","isWebhook":false,"pointer":"/paths/~1v1~1transfer/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Prescription Transfer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"PHIL will perform a prescription transfer request to a partner pharmacy to transfer ownership of a prescription. This endpoint specifies the request we will send and the response that we expect to get back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key must be included in the Authorization header with the prefix 'philKey'. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: philKey YOUR_API_KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"schemes":[{"name":"BearerTokenAuth","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":"Token must be included in the Authorization header with the prefix 'Bearer'. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferRequest","exampleIds":["paths/~1v1~1transfer/post/requestBody/content/application~1json/examples/Transfer Request"]}},"schemaId":"components/schemas/TransferRequest","exampleIds":["paths/~1v1~1transfer/post/requestBody/content/application~1json/examples/Transfer Request"],"pointer":"/paths/~1v1~1transfer/post/requestBody","description":"A JSON object containing transfer request information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/transfer","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]},{"schemes":[{"id":"BearerTokenAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TransferRequest","exampleIds":["paths/~1v1~1transfer/post/requestBody/content/application~1json/examples/Transfer Request"]}},"responseCodes":["200","400"],"pointer":"/v1/transfer","href":"partner-apis/rx-transfer","openApiOperationId":"rx-transfer","summary":"Prescription Transfer","securityGroups":[{"ApiKeyAuth":[]},{"BearerTokenAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/TransferRequest","exampleIds":["paths/~1v1~1transfer/post/requestBody/content/application~1json/examples/Transfer Request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TransferRequest","exampleIds":["paths/~1v1~1transfer/post/requestBody/content/application~1json/examples/Transfer Request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Partner has received request or completed transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Other Transfer Error"]}},"schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Other Transfer Error"]},{"code":"400","description":"Partner has received request or completed transfer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Other Transfer Error"]}},"schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Other Transfer Error"]}],"pointer":"/paths/~1v1~1transfer/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Other Transfer Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Other Transfer Error"]}}},{"code":"400","schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Other Transfer Error"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransferResponse","exampleIds":["paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Received","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Confirmed","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Missing Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Invalid Info Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Duplicate Request Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Rx Expired Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Spec Mismatch Transfer Error","paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Other Transfer Error"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partner-apis/rx-transfer"}],"panels":[]}]},"httpPath":"/v1/transfer"}],"content":{"contentType":"group","meta":{"name":"Partner APIs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partner APIs","showPageActions":true},{"nodeType":"markdoc","content":"Your APIs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/transfer","summary":"Prescription Transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partner-apis/rx-transfer","deprecated":false}]}]}]}]}},{"type":"group","label":"Request and Response Data","link":"/apis/request-and-response-data","routeSlug":"/apis/request-and-response-data","items":[{"type":"link","label":"TransferRequest","link":"/apis/request-and-response-data/transferrequest","routeSlug":"/apis/request-and-response-data/transferrequest","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TransferRequest"},"seo":{"title":"TransferRequest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TransferRequest","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TransferRequest"},"children":[]}]}]}},{"type":"link","label":"TransferResponse","link":"/apis/request-and-response-data/transferresponse","routeSlug":"/apis/request-and-response-data/transferresponse","httpVerb":"schema","content":{"contentType":"item","itemVariant":"schema","meta":{"name":"TransferResponse"},"seo":{"title":"TransferResponse"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"TransferResponse","showPageActions":true}],"panels":[]},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"schemaDefinition","attributes":{"showWriteOnly":true,"schemaRef":"#/components/schemas/TransferResponse"},"children":[]}]}]}}],"content":{"contentType":"group","meta":{"name":"Request and Response Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Request and Response Data","showPageActions":true},{"nodeType":"markdoc","content":"Details on request and response data."}],"panels":[{"children":[{"kind":"group-items","title":"Schemas","titleTranslationKey":"schemas","items":[{"title":"TransferRequest","link":"/request-and-response-data/transferrequest","deprecated":false},{"title":"TransferResponse","link":"/request-and-response-data/transferresponse","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/TransferRequest":{"id":"components/schemas/TransferRequest","kind":"json-schema","title":"TransferRequest","data":{"type":"object","x-tags":["Request and Response Data"],"properties":{"metadata":{"$ref":"#/components/schemas/RequestMetadata"},"patient":{"$ref":"#/components/schemas/Patient"},"prescriber":{"$ref":"#/components/schemas/Prescriber"},"prescription":{"$ref":"#/components/schemas/Prescription"},"sendingPharmacy":{"$ref":"#/components/schemas/Pharmacy"},"receivingPharmacy":{"$ref":"#/components/schemas/Pharmacy"},"primaryInsurance":{"$ref":"#/components/schemas/Insurance"},"secondaryInsurance":{"$ref":"#/components/schemas/Insurance"}},"required":["metadata","patient","prescriber","prescription","sendingPharmacy","receivingPharmacy","primaryInsurance","secondaryInsurance"]}},"components/schemas/TransferResponse":{"id":"components/schemas/TransferResponse","kind":"json-schema","title":"TransferResponse","data":{"type":"object","x-tags":["Request and Response Data"],"properties":{"requestID":{"type":"string","description":"the requestID from the request metadata"},"metadata":{"allOf":[{"type":"object","properties":{"responseType":{"$ref":"#/components/schemas/ResponseType"}}},{"$ref":"#/components/schemas/ResponseMetadata"}]},"error":{"$ref":"#/components/schemas/Error"},"prescription":{"$ref":"#/components/schemas/Prescription"}},"required":["requestID","metadata"]}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","properties":{"addressLine1":{"type":"string","minLength":1,"maxLength":40},"addressLine2":{"description":"Use only when needed and AddressLine1 has been used","type":"string","nullable":true,"minLength":1,"maxLength":40},"city":{"type":"string","minLength":1,"maxLength":35},"state":{"type":"string","description":"2-letter code for the state","minLength":2,"maxLength":2,"example":"WA"},"postalCode":{"type":"string","description":"5-digit or 9-digit postalCode","example":[74729,"74729-0140"]},"countryCode":{"type":"string","minLength":1,"maxLength":2}},"required":["addressLine1","addressLine2","city","state","postalCode","countryCode"]}},"components/schemas/AllergyDetails":{"id":"components/schemas/AllergyDetails","kind":"json-schema","title":"AllergyDetails","data":{"type":"object","properties":{"allergiesDescriptor":{"type":"string","enum":["KNOWN_ALLERGIES_INCLUDED","NO_KNOWN_ALLERGIES","NOT_AVAILABLE"]},"allergies":{"type":"array","description":"a list of allergy descriptions","minItems":0,"items":{"type":"string"}}},"required":["allergiesDescriptor","allergies"]}},"components/schemas/ContactInfo":{"id":"components/schemas/ContactInfo","kind":"json-schema","title":"ContactInfo","data":{"type":"object","nullable":true,"properties":{"countryCode":{"type":"string","description":"phone number coutry code","example":"+1"},"phoneNumber":{"type":"string","description":"10-digit phone number","pattern":"^\\d{10}$","example":"3231234532"}},"required":["countryCode","phoneNumber"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","description":"required if response type is an error","properties":{"type":{"$ref":"#/components/schemas/ErrorType"},"description":{"type":"string","example":"quantityDispensed amount exceeds the refillsRemaining"}}}},"components/schemas/ErrorType":{"id":"components/schemas/ErrorType","kind":"json-schema","title":"ErrorType","data":{"type":"string","enum":["MISSING_INFO","INVALID_INFO","RX_EXPIRED","SPEC_MISMATCH","DUPLICATE_REQUEST","OTHER"],"example":"INVALID_INFO","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the error types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MISSING_INFO - missing required field"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_INFO - the data does not match the expected value (e.g. no refills remaining, etc.)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RX_EXPIRED - the prescription is expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SPEC_MISMATCH - the data fields does not match the expected specifications"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DUPLICATE_REQUEST - a request has already been submitted"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OTHER"},"children":[]}]}]}]}]}},"components/schemas/Insurance":{"id":"components/schemas/Insurance","kind":"json-schema","title":"Insurance","data":{"type":"object","nullable":true,"properties":{"planName":{"type":"string","description":"Patient insurance plan name"},"cardHolderID":{"type":"string","description":"Patient insurance ID number","minLength":1,"maxLength":35},"cardHolderName":{"$ref":"#/components/schemas/Name"},"groupNumber":{"type":"string","description":"Patient insurance group number","nullable":true},"bin":{"nullable":true,"description":"Patient insurance bin","type":"string"},"pcn":{"nullable":true,"description":"Patient insurance PCN","type":"string"},"personCode":{"description":"Patient insurance person code","type":"string","pattern":"^\\d{3}$","nullable":true}},"required":["planName","cardHolderID","cardHolderName","groupNumber","bin","pcn","personCode"]}},"components/schemas/RequestMetadata":{"id":"components/schemas/RequestMetadata","kind":"json-schema","title":"RequestMetadata","data":{"type":"object","additionalProperties":true,"description":"additional information about the request and response data","properties":{"requestID":{"type":"string","description":"unique identifier for an API request"},"patientReferenceID":{"type":"string","description":"unique identifier for our patient profile"},"requestTimestamp":{"type":"string","format":"date-time","description":"timestamp for the API request."},"retryCount":{"type":"integer","description":"number of times that this request has been retried"}},"required":["requestID","patientReferenceID","requestTimestamp"]}},"components/schemas/ResponseMetadata":{"id":"components/schemas/ResponseMetadata","kind":"json-schema","title":"ResponseMetadata","data":{"type":"object","additionalProperties":true,"description":"additional information about the request and response data","properties":{"referenceID":{"type":"string","description":"unique identifier for the prescription."},"responseID":{"type":"string","description":"unique identifier for an API response."},"responseTimestamp":{"type":"string","format":"date-time","description":"timestamp for the API response."}},"required":["responseType","referenceID","responseID","responseTimestamp"]}},"components/schemas/Name":{"id":"components/schemas/Name","kind":"json-schema","title":"Name","data":{"type":"object","properties":{"lastName":{"type":"string","minLength":1,"maxLength":35},"firstName":{"type":"string","minLength":1,"maxLength":35},"middleName":{"type":"string","minLength":1,"maxLength":35,"nullable":true},"prefix":{"type":"string","minLength":1,"maxLength":10,"nullable":true},"suffix":{"type":"string","minLength":1,"maxLength":10,"nullable":true}},"required":["firstName","lastName","middleName","prefix","suffix"]}},"components/schemas/Patient":{"id":"components/schemas/Patient","kind":"json-schema","title":"Patient","data":{"type":"object","description":"Patient details","properties":{"name":{"$ref":"#/components/schemas/Name"},"dateOfBirth":{"type":"string","format":"date","example":"1992-03-20"},"gender":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code identifying the sex of the individual.:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"M - Male"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"F - Female"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"U - Not specified or unknown"},"children":[]}]}]}]}],"enum":["M","F","U"]},"address":{"$ref":"#/components/schemas/Address"},"email":{"nullable":true,"type":"string","format":"email","example":"patient@example.com"},"contactInfo":{"$ref":"#/components/schemas/ContactInfo"},"allergyDetails":{"$ref":"#/components/schemas/AllergyDetails"}},"required":["name","dateOfBirth","gender","address","email","contactInfo","allergyDetails"]}},"components/schemas/Pharmacy":{"id":"components/schemas/Pharmacy","kind":"json-schema","title":"Pharmacy","data":{"type":"object","description":"pharamcy details used for sending pharmacy (PHIL) or receiving pharmacy (partner pharmacies)","properties":{"dea":{"type":"string","description":"DEA registration number","nullable":true},"npi":{"type":"string","description":"a 10-digit identifier for the pharmacy"},"name":{"type":"string","description":"pharamcy name"},"pharmacist":{"$ref":"#/components/schemas/Name"},"address":{"$ref":"#/components/schemas/Address"},"email":{"type":"string","format":"email","example":"pharmacy@example.com"},"contactInfo":{"$ref":"#/components/schemas/ContactInfo"}},"required":["dea","npi","name","pharmacist","address","email","contactInfo"]}},"components/schemas/Prescriber":{"id":"components/schemas/Prescriber","kind":"json-schema","title":"Prescriber","data":{"type":"object","description":"a licensed healthcare professional who authorized the prescription for the patient","properties":{"dea":{"nullable":true,"type":"string","description":"DEA registration number"},"npi":{"type":"string","description":"a 10-digit identifier for the pharmacy"},"name":{"$ref":"#/components/schemas/Name"},"address":{"$ref":"#/components/schemas/Address"},"faxNumber":{"type":"string","description":"prescriber fax number","nullable":true},"email":{"nullable":true,"type":"string","format":"email","example":"doctor@example.com"},"contactInfo":{"$ref":"#/components/schemas/ContactInfo"}},"required":["dea","npi","name","address","faxNumber","email","contactInfo"]}},"components/schemas/Prescription":{"id":"components/schemas/Prescription","kind":"json-schema","title":"Prescription","data":{"type":"object","properties":{"rxNumber":{"description":"a unique number that identifies the prescription","type":"string"},"prescribedNDC":{"description":"a uniqie 11-digit code that identifies the prescribed medication","type":"string","minLength":1,"maxLength":11,"example":"47335050696"},"dispensedNDC":{"description":"a uniqie 11-digit code that identifies the medication to be dispensed. If the same as prescribedNDC, value will be null. ","type":"string","minLength":1,"maxLength":11,"nullable":true},"medicationName":{"description":"prescribed medication name","type":"string"},"drugForm":{"description":"prescribed medication form (capsules, tablets, ointment, etc.)","type":"string"},"drugStrength":{"description":"prescribed medication strength","type":"string","example":"0.03 MG"},"daysSupply":{"description":"prescribed days of supply","type":"integer","example":30},"dawCode":{"description":"dispense as written","type":"integer","minimum":0,"maximum":9,"nullable":true},"sig":{"description":"prescription sig to specify how much, how often, and how to take a medication","type":"string"},"faxImageURL":{"description":"transfer fax image URL","type":"string","nullable":true},"quantityWritten":{"description":"prescription medication quantity written","type":"number","example":8.4},"quantityDispensed":{"description":"Prescription quantity that we want dispensed for each order (may be different than what's written)","type":"number"},"refillsAuthorized":{"description":"the number of prescription refills originally written, including first fill","type":"integer"},"refillsRemaining":{"description":"the number of subsequent refills remaining on the prescription","type":"integer"},"writtenDate":{"description":"Prescription written date","type":"string","format":"date-time","example":"2024-09-11T12:00:00.000Z"},"firstFilledDate":{"description":"prescription first filled date","type":"string","format":"date-time","nullable":true},"lastFilledDate":{"description":"prescription last filled date","type":"string","format":"date-time","nullable":true},"expirationDate":{"description":"date the prescription expires","type":"string","format":"date-time","example":"2025-09-15T12:00:00.000Z"},"canSubstitute":{"description":"whether or not prescription can be substituted for another","type":"boolean"},"icdCode":{"type":"string","description":"a standardized code assigned to diagnose medical conditions","nullable":true}},"required":["rxNumber","prescribedNDC","dispensedNDC","medicationName","drugForm","drugStrength","daysSupply","dawCode","icdCode","sig","faxImageURL","quantityWritten","quantityDispensed","refillsAuthorized","refillsRemaining","writtenDate","firstFilledDate","lastFilledDate","expirationDate","canSubstitute"]}},"components/schemas/ResponseType":{"id":"components/schemas/ResponseType","kind":"json-schema","title":"ResponseType","data":{"type":"string","enum":["RECEIVED","CONFIRMED","ERROR"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the response types:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RECEIVED - the request has been received, but not yet processed. Requires a follow-up callback to confirm that the request has been completed. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/callbacks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Callbacks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONFIRMED - the request is completed and has been fully processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ERROR - the request to was unsuccessful."},"children":[]}]}]}]}]}}},"exampleStore":{"components/examples/TransferRequest":{"id":"components/examples/TransferRequest","value":{"metadata":{"requestID":"6a742tg3aof9f94t35270","requestTimestamp":"2024-09-11T12:12:00Z","patientReferenceID":"9as1tg3aofr5ata5cs84"},"patient":{"name":{"firstName":"John","middleName":null,"lastName":"Doe","prefix":null,"suffix":"Jr."},"dateOfBirth":"1992-03-20","gender":"M","address":{"addressLine1":"410 Terry Ave N","addressLine2":null,"city":"Seattle","state":"WA","postalCode":"74729","countryCode":"US"},"email":"patient@example.com","contactInfo":{"countryCode":"+1","phoneNumber":"3231234532"},"allergyDetails":{"allergiesDescriptor":"KNOWN_ALLERGIES_INCLUDED","allergies":["Peanuts","soybeans","crustacean shellfish"]}},"prescriber":{"dea":"F91234563","npi":"0987654321","name":{"firstName":"Dorothy","middleName":"Andrews","lastName":"Stevens","prefix":"Dr.","suffix":null},"address":{"addressLine1":"5372 W Common St","addressLine2":"Ste 210","city":"Seattle","state":"WA","postalCode":"74729","countryCode":"US"},"faxNumber":"7732229999","email":"doctor@example.com","contactInfo":null},"prescription":{"rxNumber":"rx1234","prescribedNDC":"82667090002","dispensedNDC":null,"medicationName":"TYRVAYA® (VARENICLINE SOLUTION) NASAL SPRAY 0.03 MG","drugForm":"Nasal spray","drugStrength":"0.03 MG","daysSupply":30,"dawCode":1,"icdCode":null,"sig":"TAKE 1 TABLET DAILY|TOME 1 TABLETA AL DIA","faxImageURL":null,"quantityWritten":8.4,"quantityDispensed":8.4,"refillsAuthorized":5,"refillsRemaining":3,"canSubstitute":false,"firstFilledDate":null,"lastFilledDate":null,"writtenDate":"2024-09-11T12:00:00Z","expirationDate":"2025-09-11T12:00:00Z"},"sendingPharmacy":{"dea":"1M34URHXA","npi":"0987654321","name":"PhilRx, LLC","address":{"addressLine1":"1234 Common St","addressLine2":null,"city":"Scottsdale","state":"AZ","postalCode":"12345","countryCode":"US"},"pharmacist":{"firstName":"Kyle","middleName":null,"lastName":"Abrams","prefix":null,"suffix":null},"email":"phil-user@phil.us","contactInfo":{"countryCode":"+1","phoneNumber":"3433548364"}},"receivingPharmacy":{"npi":"1234567890","name":"ABC Pharmacy","dea":"CW1184915","address":{"addressLine1":"123 Turn st","addressLine2":null,"city":"Atlanta","state":"GA","postalCode":"12346","countryCode":"US"},"pharmacist":{"firstName":"Georgina","middleName":null,"lastName":"Kade","prefix":null,"suffix":null},"email":"partner-user@partner.com","contactInfo":{"countryCode":"+1","phoneNumber":"4347231846"}},"primaryInsurance":{"planName":"0600CASHPAY","cardHolderID":"44444444","cardHolderName":{"firstName":"John","middleName":null,"lastName":"Doe","prefix":null,"suffix":"Jr."},"groupNumber":"GROUP1234332","bin":"600428","pcn":"06000001","personCode":null},"secondaryInsurance":null}},"components/examples/TransferConfirmed":{"id":"components/examples/TransferConfirmed","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"CONFIRMED","responseID":"32803hfas13dth82a4712","responseTimestamp":"2024-09-11T13:55:00Z"},"prescription":{"rxNumber":"rx1234","prescribedNDC":"82667090002","dispensedNDC":null,"medicationName":"TYRVAYA® (VARENICLINE SOLUTION) NASAL SPRAY 0.03 MG","drugForm":"EA","drugStrength":"0.03 MG","daysSupply":30,"dawCode":1,"icdCode":null,"sig":"TAKE 1 TABLET DAILY|TOME 1 TABLETA AL DIA","faxImageURL":null,"quantityWritten":8.4,"quantityDispensed":8.4,"refillsAuthorized":5,"refillsRemaining":3,"canSubstitute":false,"firstFilledDate":null,"lastFilledDate":null,"writtenDate":"2024-09-11T12:00:00Z","expirationDate":"2025-09-11T12:00:00Z"}},"description":"This is an synchronous response indicating that the request was fully processed and transferred. This can be returned immediately as response for the transfer request or later on via the callback API."},"components/examples/TransferReceived":{"id":"components/examples/TransferReceived","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"RECEIVED","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"}},"description":"This is an ansynchronous response indicating that the transfer request was received but not fully processed and transferred. A callback to confirm that the transfer request has been fully processed is expected."},"components/examples/InvalidInfoTransferError":{"id":"components/examples/InvalidInfoTransferError","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"INVALID_INFO","description":"quantityDispensed amount exceeds the refillsRemaining"}},"description":"This is an ansynchronous response indicating that the transfer request was could not be processed."},"components/examples/DuplicateRequestTransferError":{"id":"components/examples/DuplicateRequestTransferError","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"DUPLICATE_REQUEST","description":"prescription already exists"}},"description":"This is an ansynchronous response indicating that the transfer request was could not be processed."},"components/examples/RxExpiredTransferError":{"id":"components/examples/RxExpiredTransferError","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"RX_EXPIRED","description":"prescription already expired"}},"description":"This is an ansynchronous response indicating that the transfer request was could not be processed."},"components/examples/SpecMismatchTransferError":{"id":"components/examples/SpecMismatchTransferError","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"SPEC_MISMATCH","description":"prescriber does not match the expected specs"}},"description":"This is an ansynchronous response indicating that the transfer request was could not be processed."},"components/examples/MissingInfoTransferError":{"id":"components/examples/MissingInfoTransferError","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"MISSING_INFO","description":"prescription daysSupply is required"}},"description":"This is an ansynchronous response indicating that the transfer request was could not be processed."},"components/examples/OtherTransferError":{"id":"components/examples/OtherTransferError","value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"OTHER","description":"could not process transfer request"}},"description":"This is an ansynchronous response indicating that the transfer request was could not be processed."},"paths/~1v1~1transfer/post/requestBody/content/application~1json/examples/Transfer Request":{"value":{"metadata":{"requestID":"6a742tg3aof9f94t35270","requestTimestamp":"2024-09-11T12:12:00Z","patientReferenceID":"9as1tg3aofr5ata5cs84"},"patient":{"name":{"firstName":"John","middleName":null,"lastName":"Doe","prefix":null,"suffix":"Jr."},"dateOfBirth":"1992-03-20","gender":"M","address":{"addressLine1":"410 Terry Ave N","addressLine2":null,"city":"Seattle","state":"WA","postalCode":"74729","countryCode":"US"},"email":"patient@example.com","contactInfo":{"countryCode":"+1","phoneNumber":"3231234532"},"allergyDetails":{"allergiesDescriptor":"KNOWN_ALLERGIES_INCLUDED","allergies":["Peanuts","soybeans","crustacean shellfish"]}},"prescriber":{"dea":"F91234563","npi":"0987654321","name":{"firstName":"Dorothy","middleName":"Andrews","lastName":"Stevens","prefix":"Dr.","suffix":null},"address":{"addressLine1":"5372 W Common St","addressLine2":"Ste 210","city":"Seattle","state":"WA","postalCode":"74729","countryCode":"US"},"faxNumber":"7732229999","email":"doctor@example.com","contactInfo":null},"prescription":{"rxNumber":"rx1234","prescribedNDC":"82667090002","dispensedNDC":null,"medicationName":"TYRVAYA® (VARENICLINE SOLUTION) NASAL SPRAY 0.03 MG","drugForm":"Nasal spray","drugStrength":"0.03 MG","daysSupply":30,"dawCode":1,"icdCode":null,"sig":"TAKE 1 TABLET DAILY|TOME 1 TABLETA AL DIA","faxImageURL":null,"quantityWritten":8.4,"quantityDispensed":8.4,"refillsAuthorized":5,"refillsRemaining":3,"canSubstitute":false,"firstFilledDate":null,"lastFilledDate":null,"writtenDate":"2024-09-11T12:00:00Z","expirationDate":"2025-09-11T12:00:00Z"},"sendingPharmacy":{"dea":"1M34URHXA","npi":"0987654321","name":"PhilRx, LLC","address":{"addressLine1":"1234 Common St","addressLine2":null,"city":"Scottsdale","state":"AZ","postalCode":"12345","countryCode":"US"},"pharmacist":{"firstName":"Kyle","middleName":null,"lastName":"Abrams","prefix":null,"suffix":null},"email":"phil-user@phil.us","contactInfo":{"countryCode":"+1","phoneNumber":"3433548364"}},"receivingPharmacy":{"npi":"1234567890","name":"ABC Pharmacy","dea":"CW1184915","address":{"addressLine1":"123 Turn st","addressLine2":null,"city":"Atlanta","state":"GA","postalCode":"12346","countryCode":"US"},"pharmacist":{"firstName":"Georgina","middleName":null,"lastName":"Kade","prefix":null,"suffix":null},"email":"partner-user@partner.com","contactInfo":{"countryCode":"+1","phoneNumber":"4347231846"}},"primaryInsurance":{"planName":"0600CASHPAY","cardHolderID":"44444444","cardHolderName":{"firstName":"John","middleName":null,"lastName":"Doe","prefix":null,"suffix":"Jr."},"groupNumber":"GROUP1234332","bin":"600428","pcn":"06000001","personCode":null},"secondaryInsurance":null},"key":"Transfer Request","summary":"Transfer Request","id":"paths/~1v1~1transfer/post/requestBody/content/application~1json/examples/Transfer Request"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Received":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"RECEIVED","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"}},"key":"Transfer Request Received","summary":"Transfer Request Received","description":"This is an ansynchronous response indicating that the transfer request was received but not fully processed and transferred. A callback to confirm that the transfer request has been fully processed is expected.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Received"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Confirmed":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"CONFIRMED","responseID":"32803hfas13dth82a4712","responseTimestamp":"2024-09-11T13:55:00Z"},"prescription":{"rxNumber":"rx1234","prescribedNDC":"82667090002","dispensedNDC":null,"medicationName":"TYRVAYA® (VARENICLINE SOLUTION) NASAL SPRAY 0.03 MG","drugForm":"EA","drugStrength":"0.03 MG","daysSupply":30,"dawCode":1,"icdCode":null,"sig":"TAKE 1 TABLET DAILY|TOME 1 TABLETA AL DIA","faxImageURL":null,"quantityWritten":8.4,"quantityDispensed":8.4,"refillsAuthorized":5,"refillsRemaining":3,"canSubstitute":false,"firstFilledDate":null,"lastFilledDate":null,"writtenDate":"2024-09-11T12:00:00Z","expirationDate":"2025-09-11T12:00:00Z"}},"key":"Transfer Request Confirmed","summary":"Transfer Request Confirmed","description":"This is an synchronous response indicating that the request was fully processed and transferred. This can be returned immediately as response for the transfer request or later on via the callback API.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Transfer Request Confirmed"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Missing Info Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"MISSING_INFO","description":"prescription daysSupply is required"}},"key":"Missing Info Transfer Error","summary":"Missing Info Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Missing Info Transfer Error"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Invalid Info Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"INVALID_INFO","description":"quantityDispensed amount exceeds the refillsRemaining"}},"key":"Invalid Info Transfer Error","summary":"Invalid Info Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Invalid Info Transfer Error"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Duplicate Request Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"DUPLICATE_REQUEST","description":"prescription already exists"}},"key":"Duplicate Request Transfer Error","summary":"Duplicate Request Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Duplicate Request Transfer Error"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Rx Expired Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"RX_EXPIRED","description":"prescription already expired"}},"key":"Rx Expired Transfer Error","summary":"Rx Expired Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Rx Expired Transfer Error"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Spec Mismatch Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"SPEC_MISMATCH","description":"prescriber does not match the expected specs"}},"key":"Spec Mismatch Transfer Error","summary":"Spec Mismatch Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Spec Mismatch Transfer Error"},"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Other Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"OTHER","description":"could not process transfer request"}},"key":"Other Transfer Error","summary":"Other Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/200/content/application~1json/examples/Other Transfer Error"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Received":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"RECEIVED","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"}},"key":"Transfer Request Received","summary":"Transfer Request Received","description":"This is an ansynchronous response indicating that the transfer request was received but not fully processed and transferred. A callback to confirm that the transfer request has been fully processed is expected.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Received"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Confirmed":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"CONFIRMED","responseID":"32803hfas13dth82a4712","responseTimestamp":"2024-09-11T13:55:00Z"},"prescription":{"rxNumber":"rx1234","prescribedNDC":"82667090002","dispensedNDC":null,"medicationName":"TYRVAYA® (VARENICLINE SOLUTION) NASAL SPRAY 0.03 MG","drugForm":"EA","drugStrength":"0.03 MG","daysSupply":30,"dawCode":1,"icdCode":null,"sig":"TAKE 1 TABLET DAILY|TOME 1 TABLETA AL DIA","faxImageURL":null,"quantityWritten":8.4,"quantityDispensed":8.4,"refillsAuthorized":5,"refillsRemaining":3,"canSubstitute":false,"firstFilledDate":null,"lastFilledDate":null,"writtenDate":"2024-09-11T12:00:00Z","expirationDate":"2025-09-11T12:00:00Z"}},"key":"Transfer Request Confirmed","summary":"Transfer Request Confirmed","description":"This is an synchronous response indicating that the request was fully processed and transferred. This can be returned immediately as response for the transfer request or later on via the callback API.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Transfer Request Confirmed"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Missing Info Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"MISSING_INFO","description":"prescription daysSupply is required"}},"key":"Missing Info Transfer Error","summary":"Missing Info Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Missing Info Transfer Error"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Invalid Info Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"INVALID_INFO","description":"quantityDispensed amount exceeds the refillsRemaining"}},"key":"Invalid Info Transfer Error","summary":"Invalid Info Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Invalid Info Transfer Error"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Duplicate Request Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"DUPLICATE_REQUEST","description":"prescription already exists"}},"key":"Duplicate Request Transfer Error","summary":"Duplicate Request Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Duplicate Request Transfer Error"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Rx Expired Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"RX_EXPIRED","description":"prescription already expired"}},"key":"Rx Expired Transfer Error","summary":"Rx Expired Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Rx Expired Transfer Error"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Spec Mismatch Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"SPEC_MISMATCH","description":"prescriber does not match the expected specs"}},"key":"Spec Mismatch Transfer Error","summary":"Spec Mismatch Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Spec Mismatch Transfer Error"},"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Other Transfer Error":{"value":{"requestID":"6a742tg3aof9f94t35270","metadata":{"referenceID":"a83sad719545352gsv721","responseType":"ERROR","responseID":"ga1t6291sg6310374gs73","responseTimestamp":"2024-09-11T12:26:00Z"},"error":{"type":"OTHER","description":"could not process transfer request"}},"key":"Other Transfer Error","summary":"Other Transfer Error","description":"This is an ansynchronous response indicating that the transfer request was could not be processed.","id":"paths/~1v1~1transfer/post/responses/400/content/application~1json/examples/Other Transfer Error"}},"securitySchemeStore":{"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API key must be included in the Authorization header with the prefix 'philKey'. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: philKey YOUR_API_KEY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authorization"},"BearerTokenAuth":{"id":"BearerTokenAuth","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":"Token must be included in the Authorization header with the prefix 'Bearer'. For example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/apis","isMockServer":true,"description":"Mock server"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/index.json?download"},{"url":"/_bundle/apis/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Pharmacy API","description":"API reference for pharmacies to integrate with PHIL."}},"baseSlug":"/apis","routesMapping":{}}