Documentation Powered by ReDoc

Onegevity Health Intelligence API (1.0.0)

Download OpenAPI specification:Download

This API provides access to the Onegevity Health Intelligence Platform

Authentication

oauth2

Security Scheme Type OAuth2
clientCredentials OAuth Flow
Token URL: /oauth/token
Scopes:
  • packages_read -

    Grants read-only access to package data

  • patients_read -

    Grants read-only access to patient data

  • patients_write -

    Grants write access to patient data

  • products_read -

    Grants read-only access to product data

  • surveys_read -

    Grants read-only access to survey data

fulfillment

List Fulfillment Requests

Lists your fulfillment requests

Authorizations:
oauth2 (fulfillment)
query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "totalNumberOfElements": 1,
  • "numberOfElements": 1,
  • "fulfillmentRequests": [
    ]
}

Create Fulfillment Request

Submit a new fulfillment request

Authorizations:
oauth2 (fulfillment)
Request Body schema: application/json

Specifies the details of the fulfillment request being placed

requestIdentifier
required
string <= 35 characters [a-zA-Z0-9]+

Client-specific identifier for this fulfillment request (for example: an order number). Must be alpha-numeric.

recipientFirstName
required
string

First name of the recipient of the items to be shipped

recipientLastName
required
string

Last name of the recipient of the items to be shipped

recipientCompanyName
string

(Optional) Name of business receiving the shipment

recipientPhoneNumber
string

(Optional) Phone number to be used to contact recipient if needed

required
Array of objects (ProductAndQuantity) [ 1 .. 50 ] items

List of the items to be shipped

required
object (Address)

The location the products are to be shipped to

shippingMethod
string
Default: "GROUND"
Enum: "GROUND" "TWODAY" "NEXTDAY"

Specify the level of service requested for shipping the items in this fulfillment request

source
string

(Optional) Client-specific field that can be used to differentiate fulfillment requests created via different methods / sources /channels

notes
string

(Optional) Provide any additional notes to the carrier who will be delivering the shipment

Responses

Request samples

Content type
application/json
{
  • "requestIdentifier": "ORD12345",
  • "recipientFirstName": "John",
  • "recipientLastName": "Smith",
  • "lineItems": [
    ],
  • "shippingAddress": {
    },
  • "shippingMethod": "GROUND"
}

Response samples

Content type
application/json
{
  • "requestIdentifier": "ORD12345",
  • "recipientFirstName": "John",
  • "recipientLastName": "Smith",
  • "createdTimestamp": "2021-04-03T10:39:44Z",
  • "status": "ACCEPTED",
  • "lineItems": [
    ],
  • "shippingAddress": {
    },
  • "shippingMethod": "GROUND"
}

Fulfillment Request Details

Gets detailed information about a specific fulfillment request

Authorizations:
oauth2 (fulfillment)
path Parameters
fulfillmentRequestIdentifier
string

Client-specific identifier for the fulfillment request (for example an order #)

Responses

Response samples

Content type
application/json
Example
New Fulfillment Request
New Fulfillment Request
Completed Fulfillment Request
{
  • "requestIdentifier": "ORD12345",
  • "recipientFirstName": "John",
  • "recipientLastName": "Smith",
  • "createdTimestamp": "2021-04-03T10:39:44Z",
  • "status": "ACCEPTED",
  • "lineItems": [
    ],
  • "shippingAddress": {
    },
  • "shippingMethod": "GROUND"
}

packages

List available Onegevity packages

This is the list of all service options available to users of your system.

Authorizations:
oauth2 (packages_read)
query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json
{}

Retrieve a specific Onegevity package

Authorizations:
oauth2 (packages_read)
path Parameters
packageIdentifier
string

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Sleep Test",
  • "clientIdentifier": "SLEEP",
  • "elements": [],
  • "biomarkerGroups": [
    ],
  • "contentSections": [
    ]
}

patients

List Patients

Returns a list of patients

Authorizations:
oauth2 (patients_read)
query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "totalNumberOfElements": 1,
  • "numberOfElements": 1,
  • "patients": [
    ]
}

Create New Patient

Create a new patient record

Authorizations:
oauth2 (patients_readpatients_write)
Request Body schema: application/json

Specify the attributes of the patient to be created

patientIdentifier
required
string [ 5 .. 128 ] characters [a-zA-Z0-9-._ ]{5,128}

Client-specific identifier for this patient, something that has meaning within your own system. Must be unique and at least 5 characters long

firstName
required
string

The patient's first name

lastName
required
string

The patient's last name

gender
required
string
Enum: "FEMALE" "MALE" "UNKNOWN"

The patient's gender, if known

dateOfBirth
required
string <date>

The patient's date of birth

object

A dictionary or map of health profile attributes to values

Array of objects (PatientAgreementUpdate)

List of legal agreements accepted/declined by the patient. Only needs to be populated to indicate a change in status. Leaving this blank will not change anything.

Responses

Request samples

Content type
application/json
{
  • "patientIdentifier": "PN_1473",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "gender": "FEMALE",
  • "dateOfBirth": "1982-11-17",
  • "healthProfile": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "patientIdentifier": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "gender": "FEMALE",
  • "dateOfBirth": "2019-08-24",
  • "healthProfile": [
    ],
  • "agreements": [
    ]
}

Patient Details

Retrieves information about a specific patient

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "patientIdentifier": "PN_0371398",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "gender": "FEMALE",
  • "dateOfBirth": "1973-04-22",
  • "healthProfile": [
    ],
  • "agreements": [
    ]
}

Update Patient

Update information for an existing patient

Authorizations:
oauth2 (patients_readpatients_write)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

Request Body schema: application/json

Specify the attributes of the patient to be updated

firstName
string

The patient's first name

lastName
string

The patient's last name

gender
string
Enum: "FEMALE" "MALE" "UNKNOWN"

The patient's gender, if known

dateOfBirth
string <date>

The patient's date of birth

object

A dictionary or map of health profile attributes to values.

Responses

Request samples

Content type
application/json
{
  • "dateOfBirth": "1982-11-17",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "healthProfile": {
    }
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "patientIdentifier": "PN_0371398",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "gender": "FEMALE",
  • "dateOfBirth": "1973-04-22"
}

Update Patient Agreements

Update agreements for an existing patient

Authorizations:
oauth2 (patients_readpatients_write)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

Request Body schema: application/json

Specify the updated agreements for the patient

required
Array of objects (PatientAgreementUpdate)

List of legal agreements accepted/declined by the patient. Only needs to be populated to indicate a change in status. Existing agreement responses not provided in this list will not be altered.

Responses

Request samples

Content type
application/json
{
  • "agreements": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "patientIdentifier": "PN_0371398",
  • "firstName": "Jane",
  • "lastName": "Doe",
  • "gender": "FEMALE",
  • "dateOfBirth": "1973-04-22"
}

List Patient Agreement Documents

Returns a list of documents that patients are asked to agree to in order to receive services. For example, a HIPAA Authorization Form or Informed Consent agreement

Authorizations:
oauth2 (patients_read)
query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "totalNumberOfElements": 1,
  • "numberOfElements": 1,
  • "documents": [
    ]
}

Get Patient Agreement Document

Retrieve a specific patient agreement document

Authorizations:
oauth2 (patients_read)
path Parameters
documentIdentifier
string

Client-specific identifier for the agreement document

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "documentIdentifier": "hipaa-authorization",
  • "title": "HIPAA Authorization Form",
  • "contentType": "text/html",
  • "contentUrl": "https://fake-document-url.onegevity.com",
  • "createdTimestamp": "2020-03-22T14:22:13Z"
}

patient orders

List Patient Orders

List all of the orders for the specified patient

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "totalNumberOfElements": 1,
  • "numberOfElements": 1,
  • "orders": [
    ]
}

Create Patient Order

Creates an order of a given package for the specified patient. If no patient exists in the system with the given patientIdentifier it will also be created along with the order.

Authorizations:
oauth2 (patients_readpatients_write)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

Request Body schema: application/json

Specifies the details of the order being placed

orderIdentifier
required
string

Client-specific identifier for this order

packageIdentifier
required
string

Client-specific identifier of the Onegevity Package being ordered. (the "clientIdentifier" attribute on Package object)

required
object (PatientInformation)

Patient information required to requisition lab work for an order.

object (FulfillmentInformation)

(Optional) If present, specifies that order fulfillment is requested and defines the necessary information to ship physical items (like sample collection kits) to the patient

source
string

(Optional) Client-specific field that can be used to differentiate orders created via different methods / sources /channels

notes
string

Optional notes to include with the order for any client-specific needs.

Array of objects (KitActivation)

(Optional) Include activations for kits to avoid a subsequent call

Array of objects (LabVisitAppointment)

(Optional) Include information about appointments for lab visits to avoid a subsequent call

Responses

Request samples

Content type
application/json
Example
Create Order
Create Order
Create Order w/ Fulfillment
{
  • "orderIdentifier": "ORD_12345",
  • "packageIdentifier": "SLEEP",
  • "kitActivations": [
    ],
  • "patientInformation": {
    }
}

Response samples

Content type
application/json
Example
New Order
New Order
New Order w/ Fulfillment
{
  • "id": 1,
  • "orderIdentifier": "PO_375",
  • "completed": false,
  • "createdTimestamp": "2020-08-24T14:15:22Z",
  • "packageIdentifier": "SLEEP",
  • "packageName": "Sleep Test",
  • "notes": "Follow-up test from 9/9/2020 to see if there are improvements",
  • "elements": [
    ],
  • "relatedDocuments": []
}

Patient Order Details

Get the details for a specific patient's order

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

orderIdentifier
string

Client-specific identifier for the order

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "orderIdentifier": "PO_375",
  • "completed": false,
  • "createdTimestamp": "2020-08-24T14:15:22Z",
  • "packageIdentifier": "SLEEP",
  • "packageName": "Sleep Test",
  • "notes": "Follow-up test from 9/9/2020 to see if there are improvements",
  • "elements": [
    ],
  • "relatedDocuments": []
}

Update Patient Order

Update information about a patient order

Authorizations:
oauth2 (patients_readpatients_write)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

orderIdentifier
string

Client-specific identifier for the order

Request Body schema: application/json

Patient-provided information about this order

object (PatientInformation)

Patient information required to requisition lab work for an order.

notes
string

Optional notes to include with the order for any client-specific needs.

Array of objects (LabVisitAppointment)

Lab Visits only - Update the status of a lab visit element

Array of objects (KitActivation)

Kits only - Activate one or more kit elements

Responses

Request samples

Content type
application/json
Example
UpdateOrderWithKitActivationCodes
UpdateOrderWithKitActivationCodes
UpdateOrderWithFullRequisition
{
  • "kitActivations": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "orderIdentifier": "PO_375",
  • "completed": false,
  • "createdTimestamp": "2020-08-24T14:15:22Z",
  • "packageIdentifier": "SLEEP",
  • "packageName": "Sleep Test",
  • "notes": "Follow-up test from 9/9/2020 to see if there are improvements",
  • "elements": [
    ],
  • "relatedDocuments": []
}

patient results

List All Patient Results

Gets all released test results for the given patient.

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

object (ResultsFilter)

Options for filtering the set of test results that are returned for the patient

Responses

Response samples

Content type
application/json

Example test results

{
  • "pageNumber": 1,
  • "totalNumberOfElements": 4,
  • "numberOfElements": 4,
  • "results": [
    ]
}

List Patient Order Results

Gets the test results for a specific patient's order

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

orderIdentifier
string

Client-specific identifier for the order.

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json

Example test results

{
  • "pageNumber": 1,
  • "totalNumberOfElements": 4,
  • "numberOfElements": 4,
  • "results": [
    ]
}

List Patient Results Upload Batches

Lists all of the uploaded batches of tests results for the given patient.

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json

Example test results batches

{
  • "pageNumber": 1,
  • "totalNumberOfElements": 2,
  • "numberOfElements": 2,
  • "batches": [
    ]
}

Upload Patient Results Batch

Upload a batch of test results for the given patient

Authorizations:
oauth2 (patients_readpatients_writeresults_write)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

Request Body schema: application/json

Required information for uploading tests results for a patient

batchIdentifier
required
string

A client-specific identifier used to uniquely identify this batch of results in a way that means something to the client

object (UploadTestResultsOrderAssociation)

In addition to simply uploading test results to a patients records, specifying a patient order will trigger the downstream analysis and report generation associated with a specific Onegevity package. The uploaded results may be attached to an existing order for the patient, otherwise a new order for the patient will be created.

reportedTimestamp
required
string <date-time>

The date and time that the test results were reported from the lab.

required
Array of objects [ 1 .. 1000 ] items

The list of test results observed that should be uploaded as part of this batch

Responses

Request samples

Content type
application/json
{
  • "batchIdentifier": "string",
  • "patientOrder": {
    },
  • "reportedTimestamp": "2019-08-24T14:15:22Z",
  • "testResults": [
    ]
}

Response samples

Content type
application/json

Example test results batch

{
  • "id": 3882,
  • "batchIdentifier": "PT135_2022_01_01",
  • "createdTimestamp": "2020-03-22T14:22:13Z",
  • "releasedTimestamp": "2020-03-22T14:22:51Z",
  • "reportedTimestamp": "2020-03-18T03:47:05Z",
  • "resultCount": 39,
  • "status": "PROCESSED"
}

Patient Results Upload Batch Details

Gets detailed information about a specific batch of uploaded test results for the given patient.

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

batchIdentifier
string

Client-specific identifier for the batch of uploaded test results.

Responses

Response samples

Content type
application/json
Example
TestResultsBatchDetail
TestResultsBatchDetail
TestResultsBatchDetailWithErrors

Example test results batch

{
  • "id": 3882,
  • "batchIdentifier": "PT135_2022_01_01",
  • "createdTimestamp": "2020-03-22T14:22:13Z",
  • "releasedTimestamp": "2020-03-22T14:22:51Z",
  • "reportedTimestamp": "2020-03-18T03:47:05Z",
  • "resultCount": 39,
  • "status": "PROCESSED"
}

Update Patient Results Upload Batch

Update the status of an uploaded batch of patient test results

Authorizations:
oauth2 (patients_readpatients_writeresults_write)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

batchIdentifier
string

Client-specific identifier for the batch of uploaded test results.

Request Body schema: application/json

The updates to be made to the results batch

action
string
Enum: "RELEASE" "DELETE"

Specifies the action to take on the given batch of test results. 'RELEASE' accepts the batch of results as-is, even if there were errors, and makes the uploaded test results available for downstream processing. 'DELETE' flags the batch as unusable and makes it unavailable for any downstream processing.

Responses

Request samples

Content type
application/json
Example
Release Results Batch
Release Results Batch
Delete Results Batch

Example updating test result batch to release the results for downstream processing

{
  • "action": "RELEASE"
}

Response samples

Content type
application/json
Example
TestResultsBatchDetail
TestResultsBatchDetail
TestResultsBatchDetailWithErrors

Example test results batch

{
  • "id": 3882,
  • "batchIdentifier": "PT135_2022_01_01",
  • "createdTimestamp": "2020-03-22T14:22:13Z",
  • "releasedTimestamp": "2020-03-22T14:22:51Z",
  • "reportedTimestamp": "2020-03-18T03:47:05Z",
  • "resultCount": 39,
  • "status": "PROCESSED"
}

List Results For Upload Batch

Gets all test results uploaded in the given batch for the given patient.

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient.

batchIdentifier
string

Client-specific identifier for the batch of uploaded test results.

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json

Example test results

{
  • "pageNumber": 1,
  • "totalNumberOfElements": 4,
  • "numberOfElements": 4,
  • "results": [
    ]
}

patient reports

List Patient Reports

Retrieve a paged list of the patient's reports

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

object (ReportsFilter)
Example: createdAfter=2020-01-01&packageIdentifier=SLEEP

Options for filtering the set of reports that are returned for the patient

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "numberOfElements": 2,
  • "totalNumberOfElements": 2,
  • "reports": [
    ]
}

List Patient Order Reports

Retrieve a paged list of the reports for a specific patient order

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

orderIdentifier
string

Client-specific identifier for the patient order

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "numberOfElements": 2,
  • "totalNumberOfElements": 2,
  • "reports": [
    ]
}

Patient Report Details

Retrieve the detailed contents of a specific patient report

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

reportId
integer <int64>

The id of the report to view

Responses

Response samples

Content type
application/json
Example
Thyroid (Patient Facing)
Thyroid (Patient Facing)
Stress (Patient Facing)
Gut Health (Patient Facing)
Biological Age (Patient Facing)
{
  • "id": 271,
  • "name": "Thyroid",
  • "type": "patient-facing",
  • "createdTimestamp": "2020-08-24T14:15:22Z",
  • "summarySection": {
    },
  • "bodySections": [
    ],
  • "appendixSections": [ ]
}

patient recommendations

List Patient Recommendations

Retrieve a paged list of the patient's recommendations

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

object (RecommendationsFilter)
Example: createdAfter=2020-01-01&includeArchived=false&recommendationType=diet,product

Options for filtering the set of reports that are returned for the patient

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "numberOfElements": 3,
  • "totalNumberOfElements": 3,
  • "recommendations": [
    ]
}

Patient Recommendation Details

Retrieve the detailed contents of a specific patient recommendation

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

recommendationId
integer <int64>

The id of the recommendation to view

Responses

Response samples

Content type
application/json
Example
Diet Recommendation
Diet Recommendation
Lifestyle Recommendation
Product Recommendation
{
  • "id": 24,
  • "name": "Functional Nutrition Drink",
  • "recommendationType": "diet",
  • "category": "FUNCTIONAL_NUTRITION_DRINK",
  • "archived": false,
  • "createdTimestamp": "2020-08-24T14:15:22Z",
  • "sources": [
    ],
  • "content": "Mix in 14 oz. of cold water and consume daily for 30 days. This is your personalized prebiotic and foundational nutrition drink ..."
}

Update Patient Recommendation

Updates a specific patient recommendation

Authorizations:
oauth2 (patients_read)
path Parameters
patientIdentifier
string

Client-specific identifier for the patient

recommendationId
integer <int64>

The id of the recommendation to update

Request Body schema: application/json

Specifies the changes to be made to the recommendation

archived
required
boolean

Setting a recommendation to archived will cause to be hidden when listing a patient's recommendations using the default filters

Responses

Request samples

Content type
application/json
{
  • "archived": true
}

Response samples

Content type
application/json
Example
Diet Recommendation
Diet Recommendation
Lifestyle Recommendation
Product Recommendation
{
  • "id": 24,
  • "name": "Functional Nutrition Drink",
  • "recommendationType": "diet",
  • "category": "FUNCTIONAL_NUTRITION_DRINK",
  • "archived": false,
  • "createdTimestamp": "2020-08-24T14:15:22Z",
  • "sources": [
    ],
  • "content": "Mix in 14 oz. of cold water and consume daily for 30 days. This is your personalized prebiotic and foundational nutrition drink ..."
}

products

List Products

List all available products

Authorizations:
oauth2 (products_read)
query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

productIdentifier
Array of strings <= 20 characters

(Optional) - You may provide an arbitrary number of productIdentifiers to retrieve information about a batch of up to 20 products with one request

Responses

Response samples

Content type
application/json
{}

Product Details

Gets the details for a specific product

Authorizations:
oauth2 (products_read)
path Parameters
productIdentifier
string

Responses

Response samples

Content type
application/json
{}

surveys

List Surveys

Returns a paged list of survey summaries; in-which excludes the questions. To get the detailed representation, a call must be made to retrieve the Survey Details

Authorizations:
oauth2 (surveys_read)
query Parameters
object (Paging)

Specifies paging and sorting properties for requests that return lists of items

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 1,
  • "totalNumberOfElements": 1,
  • "numberOfElements": 1,
  • "surveys": [
    ]
}

Survey Details

Retrieves details about a specific survey

Authorizations:
oauth2 (surveys_read)
path Parameters
key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "version": "1",
  • "title": "General Health",
  • "key": "general-health",
  • "description": "A general health survey",
  • "sections": [
    ]
}

patient surveys

Patient Survey

Retrieves a survey that is filled out with the patient's response profile. To get the survey with results for a specific order and or version, use the relative query parameters.

Authorizations:
oauth2 (surveys_readpatients_read)
path Parameters
patientIdentifier
required
string
key
required
string
query Parameters
orderIdentifier
string
version
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "version": 3,
  • "versionTimestamp": "2020-08-24T14:15:22Z",
  • "survey": {
    }
}

Submit Patient Survey

Submits a survey for the given patient. To submit the survey tied to an order, then the order identifier need be specified on the request body.

Authorizations:
oauth2 (surveys_readpatients_write)
path Parameters
patientIdentifier
required
string
key
required
string
Request Body schema: application/json

The answered survey as well as optional settings controlling whether and how patient orders are updated with the survey results

updateOrders
boolean
Default: false

Indicates whether or not the survey responses should be used for a patients order(s). If set to "true", the orderIdentifierFilters attribute controls which orders get updated.

orderIdentifierFilters
Array of strings

The list of order identifiers that will be used to filter which patient orders get updated with the survey responses. If left empty, all the patients active orders that include this survey will be updated. Has no effect if updateOrders is "false".

complete
boolean
Default: false

Boolean value indicating whether or not the client wishes to mark the updated orders survey element to complete or not.

required
object

A dictionary or map of options to values.

Responses

Request samples

Content type
application/json
Example
Submit Patient Survey - Update Single Order
Submit Patient Survey - Update Single Order
Submit Patient Survey - Update Multiple Orders

Example submitting the patient survey results for a specific order, marking the order survey requirement as complete

{
  • "updateOrders": true,
  • "orderIdentifierFilters": [
    ],
  • "complete": true,
  • "responses": {
    }
}

Response samples

Content type
application/json
{
  • "version": 3,
  • "versionTimestamp": "2020-08-24T14:15:22Z",
  • "survey": {
    }
}