Skip to main content

PUT Order

When an order is created in the LetsGetChecked system, it is immediately set for dispatch by our team. Generally, an order dispatch occurs within one business day of order creation.

Order operations are created to manage the client/customer purchases with LetsGetChecked. The operation is idempotent. If the response of the operation is not obtained, for example if the connection breaks, the client application can retry. If the previous invocation never arrived it runs for the first time, and if it runs, the previous result is returned.

The current default rate limit is set to 10,000 requests per millisecond.

Request

Endpoint

Headers

Path parameters

Sample request

Request definitions

Response

Sample response

Request

Endpoint

PUT {clientId}/api/v1/orders/{clientOrderId}

Create a unique order for a specific client.

Headers

The PUT Order API requires the following information in the headers of an HTTP request:

HTTP HeaderDescription
AuthorizationThe HTTP Authorization request header contains the credentials to authenticate a user agent with a server.
AcceptThe HTTP Accept request header contains information about the content types, expressed as MIME types, that the client can understand. The MIME type for the PUT Order API request is application/json.
Content-TypeThe Content-Type request header defines the type of data that the client sends to the server. For the PUT Order API request, the type of data is application/json.

Path parameters

ParameterDescriptionTypeRequired/Optional
clientIdThe clientId is a unique code that is provided by LetsGetChecked. The clientId is used to identify a client, when a client calls the Orders and Results APIs. The code is a number between 0 and 9999. The clientId displays in the HL7 results as PV1.3.1.stringRequired
clientOrderIdThe clientOrderId is a unique ID, per order, in the client's system. This can be a maximum length of 50 characters. When a client application uses the Order API, a clientOrderId value is generated by the client that is the reference for the order in the LetsGetChecked system. The Client Order ID displays in the HL7 results as an AOE OBX segment.stringRequired

Sample request

{
"Address":{
"addressLine1":"Line1",
"addressLine2":"Line2",
"city":"Boston",
"countryIsoAlpha2":"US",
"postalCode":"55555",
"state":"AL"
},
"patientInfo":{
"participantId":"11111",
"firstName":"fName",
"lastName":"lName",
"email":"test@email.com",
"phoneNumber":{
"phoneCountryCode":"+1",
"phoneNumber":"555588888"
},
"gender":"Male",
"dob":"2000-01-01",
"ethnicity":"Hispanic",
"race":"UnknownRace",
"participantLanguage":"ENGLISH",
"participantResultsId":null,
"healthPlanName":"payerPlanName"
},
"clientSubCode":"01",
"clientLocationEventId":"01",
"diagnosisCodes":[
"D01"
],
"programCode":"Health4All",
"primaryCareProvider":{
"id":"PCP1234567",
"firstName":"test",
"middleName":"middle",
"lastName":"last",
"address":{
"addressLine1":"Adelphi House",
"addressLine2":"Dún Laoghaire",
"city":"Dublin",
"countryIsoAlpha2":"IR",
"postalCode":"A96 YC63"
},
"phone":"965878945",
"phone2":"123456789",
"fax":"8181818181"
},
"questionnaireInfo":{
"gender":"female",
"countryIsoAlpha2":"US",
"testKitCode":"TKCODE",
"answers":[
{
"questionId":"fc422870-41a5-488a-bef7-9c3db6f622a4",
"selections":[
{
"choiceIndex":1,
"answerValue":"No, I have never smoked regularly"
}
]
}
]
},
"customData":[
{
"key":"appointmentTime",
"value":"2021-11-18T13:34:30"
},
{
"key":"key2",
"value":"value2"
},
{
"key":"key3",
"value":"value3"
}
]
}

Request definitions

The following table describes each item in the body of the request:

ElementDescriptionTypeRequired/Optional
addressThe user’s address based on the address in the request.object(Address)Required
address /addressLine1The first line of the user’s address. This can be a maximum length of 35 characters.stringRequired
address /addressLine2The second line of the user’s address. This can be a maximum length of 35 characters.stringOptional
address /cityThe user’s city.stringRequired
address /countryIsoAlpha2The user’s country. LetsGetChecked uses the ISO-3166 standard to define internationally recognized codes for a country. Allowed value: USstringRequired
address /postalCodeThe user’s postal code or zip code.stringRequired
address /stateThe user’s state. Allowed values: AL, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, PR, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WYstringRequired
PatientInfoInformation about the patient.object(PatientInfo)Required
PatientInfo /participantIdThe Participant ID must be unique and associated with a person in your system of record. It can be an employee ID or Customer ID. Do not reuse or recycle Participant IDs.stringRequired
PatientInfo/participantId /firstNameThe patient’s first name.stringRequired
PatientInfo/participantId /lastNameThe patient’s last name.stringRequired
PatientInfo/participantId /emailThe patient’s email address.stringOptional
PatientInfo/participantId /PhoneNumberThe patient’s phone number.stringRequired
PatientInfo/participantId/PhoneNumber /phoneCountryCodeThe country code of the user’s phone number.stringRequired
PatientInfo/participantId/PhoneNumber /phoneNumberThe remaining digits of the user’s phone number, after the country code.stringRequired
PatientInfo /genderThe patient’s gender. The following case agnostic values are allowed:
  • MALE, Male, male
  • FEMALE, Female, female
stringRequired
PatientInfo /dobThe patient’s date of birth. The format is YYYY-MM-DD.stringRequired
PatientInfo /ethnicityThe patient’s ethnicity. The following values are allowed:
  • NoEthnicityProvided
  • Hispanic
  • NotHispanic
stringRequired
PatientInfo /raceThe patient’s race. The following values are allowed: UnknownRace, AmericanIndian, NativeAlaskan, Asian, AfricanAmerican, African, Hispanic, Latino, PacificIslander, NativeHawaiian, Caucasian, AshkenaziOrSephardiJewish, OtherRacestringRequired
PatientInfo /participantLanguageThe patient’s language. The following case agnostic values are allowed:
  • ENGLISH, English, english
  • SPANISH, Spanish, spanish
stringOptional
PatientInfo /healthPlanNameThe sub-plan name for the current payer.stringOptional
programCodeThe code associated with the program, that is provided by LetsGetChecked. A different program code is associated with each test kit type.stringRequired
primaryCareProviderThe patient Primary Care Provider (PCP) information.object(PrimaryCareProvider)Optional
primaryCareProvider /idThe PCP unique identicator
  • Empty is allowed (indicates that there is no provider for the patient)
  • Alphanumeric is allowed
  • Maximum length of 15 characters
stringRequired
primaryCareProvider /firstNameThe PCP's first name. Tip: Together, the first, middle, and last names combined should have less than 100 characters.stringRequired
primaryCareProvider /middleNameThe PCP's middle name. Tip: Together, the first, middle, and last names combined should have less than 100 characters.stringOptional
primaryCareProvider /lastNameThe PCP's last name. Tip: Together, the first, middle, and last names combined should have less than 100 characters.stringRequired
primaryCareProvider /phoneThe PCP's phone number.stringOptional
primaryCareProvider /phone2The PCP's secondary phone number.stringOptional
primaryCareProvider /faxThe PCP's fax number.stringOptional
primaryCareProvider /addressThe PCP's address.object(Address)Required
QuestionnaireInfoThe LetsGetChecked questionnaire for a test kit.object(QuestionnaireInfo)Optional
QuestionnaireInfo /genderThe gender of the person completing the questionnaire.stringRequired
QuestionnaireInfo /countryIsoAlpha2The country where the person is located, who is completing the questionnaire.stringRequired
QuestionnaireInfo/testKitCodeThe code for the test kit.stringRequired
QuestionnaireInfo/answersThe LetsGetChecked answers for a questionnaire.Array of object(Answer)Required
customDataContains any additional custom data that is associated with an order.
  • Custom data must be in the format of key-value pairs.
  • Alphanumeric characters are allowed.
  • Maximum length of 50 characters.
Use cases for customData
  • Sending appointment times so that LetsGetChecked can ship orders based on appointment dates.
  • Adding extra information to an order such as a patient's location or the name of the clinic they visit. Customers can then use filters on reports for the order, for example, to categorize a patient by city or clinic.
List of key-value pairsOptional
noteContains any additional notes or information.stringOptional
PhysicianInfoThe physician information. You can use this object to submit physician information for a physician that does not order from LetsGetChecked.object(PhysicianInfo)Optional
PhysicianInfo /firstNameThe first name of the physician.stringRequired
PhysicianInfo /middleNameThe middle name of the physician.stringOptional
PhysicianInfo /lastNameThe last name of the physician.stringRequired
PhysicianInfo /npiThe National Provider Identifier (NPI) for the physician.integerRequired
answersThe LetsGetChecked answers for a questionnaire for a test kit.object(answers)Optional
answers /questionIdUnique ID of the answer.Guid QuestionIdRequired
answers /selectionsArray of the selected answer choices for the answers.Array of object(selections)Required
selectionsThe LetsGetChecked selection choices for an answer for a questionnaire for a test kit.object(selections)Optional
selections /choiceIndexIndex of the choice chosen.integerRequired
selections /answerValueValue of the answer.stringRequired
selections /supportingFieldValueSupporting value associated with the answer.stringOptional
clientSubCodeThis code can be associated with a particular testing initiative, program, client organizational entity, building, or location.stringOptional
clientLocationEventIdThis code can be associated with a particular location for shipping supplies and reporting.stringOptional
diagnosisCodesThe diagnosis code. It displays in the HL7 results as one DG1 segment per code.Array of stringOptional

Response

The sample response is a single JSON object that contains the following fields:

PropertyDescriptionType
clientOrderIdThe clientOrderId is a unique ID, per order, in the client's system. This can be a maximum length of 50 characters. When a client application uses the Order API, a clientOrderId value is generated by the client that is the reference for the order in the LetsGetChecked system.string
participantIdThe participantId must be unique and associated with someone in your system of record. It can be an employee ID or Customer ID. Do not reuse or recycle participant IDs.string
lgcOrderRefThe unique LetsGetChecked order reference for the original order in the LetsGetChecked system.Guid

Sample response

{
"clientOrderId":"1234567",
"participantId":"11111",
"lgcOrderRef":"e392d458-f31e-40fb-b7a5-ee3a9ba71fdc"
}