POST papi/v1/integration/receivelabtestresult?fileUid={fileUid}&fileName={fileName}
Security
Secured API
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
fileUid | globally unique identifier |
Required |
|
fileName | string |
Required |
Required Headers
Name | Description | Sample | Type | Default |
---|---|---|---|---|
Authorization |
Represents the value of the authentication token. Allow multiple values: no. |
Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ... | string | None |
ConsumerId |
Represents the value of the consumer id. Allow multiple values: no. |
2426 | integer | None |
Optional Headers
Name | Description | Sample | Type | Default |
---|---|---|---|---|
ApplicationType |
Represents the value of the consumer's application type. Allow multiple values: no. |
1 | ApplicationType | None |
Accept-Language |
Represents the value of the desired language for translations. Allow multiple values: yes. |
es | string | en |
Body Parameters
DonorName | Description | Type | Additional information |
---|---|---|---|
ResultState | string |
None. |
|
OrderClient | DonorOrderClient |
None. |
|
Specimen | DonorSpecimen |
None. |
|
ClientSiteLocation | DonorClientSiteLocation |
None. |
|
Reporting | DonorReporting |
None. |
|
QuestLab | DonorQuestLab |
None. |
|
CollectionSite | DonorCollectionSite |
None. |
|
Results | Collection of DonorResult |
None. |
|
ReportBody | DonorReportBody |
None. |
Request Formats
application/json, text/json
Sample:
{ "resultStateField": "sample string 1", "orderClientField": { "clientNumberField": "sample string 1", "clientNameField": "sample string 2", "clientAttnField": "sample string 3", "clientAccountDescriptionField": "sample string 4", "addressField": { "streetAddressField": "sample string 1", "cityField": "sample string 2", "stateField": "sample string 3", "zipField": "sample string 4", "phoneField": "sample string 5", "faxField": "sample string 6" } }, "specimenField": { "referenceTestIDField": "sample string 1", "requisitionNumberField": "sample string 2", "uniqueRequisitionIDField": "sample string 3", "labAccessionNumberField": "sample string 4", "donorPrimaryIDField": "sample string 5", "donorSecondaryIDField": "sample string 6", "reasonForTestField": "sample string 7", "donorVerificationFlagField": "sample string 8", "specimenCollectionDateField": "sample string 9", "specimenCollectionTimeField": "sample string 10", "specimenReceivedDateField": "sample string 11", "specimenReceivedTimeField": "sample string 12", "textField": [ "sample string 1", "sample string 2" ] }, "clientSiteLocationField": { "clientSiteLocationIDField": {}, "addressField": { "nameField": "sample string 1", "streetAddressField": "sample string 2", "streetAddress2Field": "sample string 3", "streetAddress3Field": "sample string 4" } }, "reportingField": { "reportDateField": "sample string 1", "reportTimeField": "sample string 2", "resultsIndicatorField": "sample string 3", "reportVerificationTimestampField": "sample string 4", "specimenIDField": "sample string 5", "reportCommentsField": [ "sample string 1", "sample string 2" ] }, "questLabField": { "questLabIDField": "sample string 1", "questLabNameField": "sample string 2", "certifiedScientistField": "sample string 3", "addressField": { "streetAddressField": "sample string 1", "cityField": "sample string 2", "stateField": "sample string 3", "zipField": "sample string 4" } }, "collectionSiteField": { "collectionSiteIDField": "sample string 1", "addressField": { "nameField": "sample string 1", "streetAddressField": "sample string 2", "streetAddress2Field": "sample string 3", "cityField": "sample string 4", "stateField": "sample string 5", "zipField": "sample string 6", "phoneField": "sample string 7", "faxField": "sample string 8" } }, "resultsField": [ { "unitCodeMneField": "sample string 1", "unitCodeNumberField": "sample string 2", "unitCodeReportName1Field": "sample string 3", "unitCodeReportName2Field": "sample string 4", "unitCodeReqShortBillNameField": "sample string 5", "unitCodeRefexField": "sample string 6", "unitCodeQBSBillCodeField": "sample string 7", "profileCodeMneField": "sample string 8", "testCodeMneField": "sample string 9", "testCodeNameField": "sample string 10", "testCodeNumberField": "sample string 11", "testCodeTypeField": "sample string 12", "resultStatusField": "sample string 13", "clinicalStatusField": "sample string 14", "resultValueField": "sample string 15", "unitsOfMeasureField": "sample string 16", "referenceRangeLowField": "sample string 17", "referenceRangeHighField": "sample string 18", "referenceRange1Field": "sample string 19", "referenceRange2Field": "sample string 20", "specimenTypeField": "sample string 21", "orderableTypeField": "sample string 22", "screeningCutoffField": "sample string 23", "confirmationCutoffField": "sample string 24", "gCMSLevelField": "sample string 25", "classTestCodeMneField": "sample string 26", "classTestCodeCutoffField": "sample string 27", "alphaInformationField": { "resultTypeField": "sample string 1", "alphaResultField": "sample string 2", "messageCodeField": "sample string 3", "messageCategoryField": "sample string 4" } }, { "unitCodeMneField": "sample string 1", "unitCodeNumberField": "sample string 2", "unitCodeReportName1Field": "sample string 3", "unitCodeReportName2Field": "sample string 4", "unitCodeReqShortBillNameField": "sample string 5", "unitCodeRefexField": "sample string 6", "unitCodeQBSBillCodeField": "sample string 7", "profileCodeMneField": "sample string 8", "testCodeMneField": "sample string 9", "testCodeNameField": "sample string 10", "testCodeNumberField": "sample string 11", "testCodeTypeField": "sample string 12", "resultStatusField": "sample string 13", "clinicalStatusField": "sample string 14", "resultValueField": "sample string 15", "unitsOfMeasureField": "sample string 16", "referenceRangeLowField": "sample string 17", "referenceRangeHighField": "sample string 18", "referenceRange1Field": "sample string 19", "referenceRange2Field": "sample string 20", "specimenTypeField": "sample string 21", "orderableTypeField": "sample string 22", "screeningCutoffField": "sample string 23", "confirmationCutoffField": "sample string 24", "gCMSLevelField": "sample string 25", "classTestCodeMneField": "sample string 26", "classTestCodeCutoffField": "sample string 27", "alphaInformationField": { "resultTypeField": "sample string 1", "alphaResultField": "sample string 2", "messageCodeField": "sample string 3", "messageCategoryField": "sample string 4" } } ], "reportBodyField": { "textField": "sample string 1" } }
application/xml, text/xml
Sample:
<Donor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ResultState>sample string 1</ResultState> <OrderClient> <ClientNumber>sample string 1</ClientNumber> <ClientName>sample string 2</ClientName> <ClientAttn>sample string 3</ClientAttn> <ClientAccountDescription>sample string 4</ClientAccountDescription> <Address> <StreetAddress>sample string 1</StreetAddress> <City>sample string 2</City> <State>sample string 3</State> <Zip>sample string 4</Zip> <Phone>sample string 5</Phone> <Fax>sample string 6</Fax> </Address> </OrderClient> <Specimen> <ReferenceTestID>sample string 1</ReferenceTestID> <RequisitionNumber>sample string 2</RequisitionNumber> <UniqueRequisitionID>sample string 3</UniqueRequisitionID> <LabAccessionNumber>sample string 4</LabAccessionNumber> <DonorPrimaryID>sample string 5</DonorPrimaryID> <DonorSecondaryID>sample string 6</DonorSecondaryID> <ReasonForTest>sample string 7</ReasonForTest> <DonorVerificationFlag>sample string 8</DonorVerificationFlag> <SpecimenCollectionDate>sample string 9</SpecimenCollectionDate> <SpecimenCollectionTime>sample string 10</SpecimenCollectionTime> <SpecimenReceivedDate>sample string 11</SpecimenReceivedDate> <SpecimenReceivedTime>sample string 12</SpecimenReceivedTime>sample string 1sample string 2</Specimen> <ClientSiteLocation> <ClientSiteLocationID /> <Address> <Name>sample string 1</Name> <StreetAddress>sample string 2</StreetAddress> <StreetAddress2>sample string 3</StreetAddress2> <StreetAddress3>sample string 4</StreetAddress3> </Address> </ClientSiteLocation> <Reporting> <ReportDate>sample string 1</ReportDate> <ReportTime>sample string 2</ReportTime> <ResultsIndicator>sample string 3</ResultsIndicator> <ReportVerificationTimestamp>sample string 4</ReportVerificationTimestamp> <SpecimenID>sample string 5</SpecimenID> <ReportComments> <ReportComment>sample string 1</ReportComment> <ReportComment>sample string 2</ReportComment> </ReportComments> </Reporting> <QuestLab> <QuestLabID>sample string 1</QuestLabID> <QuestLabName>sample string 2</QuestLabName> <CertifiedScientist>sample string 3</CertifiedScientist> <Address> <StreetAddress>sample string 1</StreetAddress> <City>sample string 2</City> <State>sample string 3</State> <Zip>sample string 4</Zip> </Address> </QuestLab> <CollectionSite> <CollectionSiteID>sample string 1</CollectionSiteID> <Address> <Name>sample string 1</Name> <StreetAddress>sample string 2</StreetAddress> <StreetAddress2>sample string 3</StreetAddress2> <City>sample string 4</City> <State>sample string 5</State> <Zip>sample string 6</Zip> <Phone>sample string 7</Phone> <Fax>sample string 8</Fax> </Address> </CollectionSite> <Results> <Result> <UnitCodeMne>sample string 1</UnitCodeMne> <UnitCodeNumber>sample string 2</UnitCodeNumber> <UnitCodeReportName1>sample string 3</UnitCodeReportName1> <UnitCodeReportName2>sample string 4</UnitCodeReportName2> <UnitCodeReqShortBillName>sample string 5</UnitCodeReqShortBillName> <UnitCodeRefex>sample string 6</UnitCodeRefex> <UnitCodeQBSBillCode>sample string 7</UnitCodeQBSBillCode> <ProfileCodeMne>sample string 8</ProfileCodeMne> <TestCodeMne>sample string 9</TestCodeMne> <TestCodeName>sample string 10</TestCodeName> <TestCodeNumber>sample string 11</TestCodeNumber> <TestCodeType>sample string 12</TestCodeType> <ResultStatus>sample string 13</ResultStatus> <ClinicalStatus>sample string 14</ClinicalStatus> <ResultValue>sample string 15</ResultValue> <UnitsOfMeasure>sample string 16</UnitsOfMeasure> <ReferenceRangeLow>sample string 17</ReferenceRangeLow> <ReferenceRangeHigh>sample string 18</ReferenceRangeHigh> <ReferenceRange1>sample string 19</ReferenceRange1> <ReferenceRange2>sample string 20</ReferenceRange2> <SpecimenType>sample string 21</SpecimenType> <OrderableType>sample string 22</OrderableType> <ScreeningCutoff>sample string 23</ScreeningCutoff> <ConfirmationCutoff>sample string 24</ConfirmationCutoff> <GCMSLevel>sample string 25</GCMSLevel> <ClassTestCodeMne>sample string 26</ClassTestCodeMne> <ClassTestCodeCutoff>sample string 27</ClassTestCodeCutoff> <AlphaInformation> <ResultType>sample string 1</ResultType> <AlphaResult>sample string 2</AlphaResult> <MessageCode>sample string 3</MessageCode> <MessageCategory>sample string 4</MessageCategory> </AlphaInformation> </Result> <Result> <UnitCodeMne>sample string 1</UnitCodeMne> <UnitCodeNumber>sample string 2</UnitCodeNumber> <UnitCodeReportName1>sample string 3</UnitCodeReportName1> <UnitCodeReportName2>sample string 4</UnitCodeReportName2> <UnitCodeReqShortBillName>sample string 5</UnitCodeReqShortBillName> <UnitCodeRefex>sample string 6</UnitCodeRefex> <UnitCodeQBSBillCode>sample string 7</UnitCodeQBSBillCode> <ProfileCodeMne>sample string 8</ProfileCodeMne> <TestCodeMne>sample string 9</TestCodeMne> <TestCodeName>sample string 10</TestCodeName> <TestCodeNumber>sample string 11</TestCodeNumber> <TestCodeType>sample string 12</TestCodeType> <ResultStatus>sample string 13</ResultStatus> <ClinicalStatus>sample string 14</ClinicalStatus> <ResultValue>sample string 15</ResultValue> <UnitsOfMeasure>sample string 16</UnitsOfMeasure> <ReferenceRangeLow>sample string 17</ReferenceRangeLow> <ReferenceRangeHigh>sample string 18</ReferenceRangeHigh> <ReferenceRange1>sample string 19</ReferenceRange1> <ReferenceRange2>sample string 20</ReferenceRange2> <SpecimenType>sample string 21</SpecimenType> <OrderableType>sample string 22</OrderableType> <ScreeningCutoff>sample string 23</ScreeningCutoff> <ConfirmationCutoff>sample string 24</ConfirmationCutoff> <GCMSLevel>sample string 25</GCMSLevel> <ClassTestCodeMne>sample string 26</ClassTestCodeMne> <ClassTestCodeCutoff>sample string 27</ClassTestCodeCutoff> <AlphaInformation> <ResultType>sample string 1</ResultType> <AlphaResult>sample string 2</AlphaResult> <MessageCode>sample string 3</MessageCode> <MessageCategory>sample string 4</MessageCategory> </AlphaInformation> </Result> </Results> <ReportBody> <Text>sample string 1</Text> </ReportBody> </Donor>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
DrugResultInboundResponseName | Description | Type | Additional information |
---|---|---|---|
FileUid | globally unique identifier |
None. |
|
IsBatchSuccessful | boolean |
None. |
|
BatchExceptionMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "FileUid": "a4bb698e-db6d-4caa-b47d-aab10d6619f1", "IsBatchSuccessful": true, "BatchExceptionMessage": "sample string 3" }
application/xml, text/xml
Sample:
<DrugResultInboundResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <FileUid>a4bb698e-db6d-4caa-b47d-aab10d6619f1</FileUid> <IsBatchSuccessful>true</IsBatchSuccessful> <BatchExceptionMessage>sample string 3</BatchExceptionMessage> </DrugResultInboundResponse>