Surveys

Get all surveys of organization

get

Retrieve all surveys for the organization

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

idstring[]Optional

Array of IDs

Default: []Example: ["id1","id2"]

surveyIdstring[]Optional

Array of survey IDs

Default: []Example: ["survey1","survey2"]

isConsentbooleanOptional

surveys consent status

Example: true

namestring[]Optional

Array of names

Default: []Example: ["name1","name2"]

orderBystringOptional

Order by field

Example: name

organizationIdnumberOptional

orderDirectionstringOptional

Order direction

Default: ascExample: asc

Responses

200Success

application/json

get

/api/surveys

HTTPcURLJavaScriptPython

GET /api/surveys HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": 12,
    "isConsent": true,
    "resourceType": "Survey",
    "userType": "CONSUMER",
    "organizationId": 123,
    "url": "http://example.com/survey",
    "version": "1.0",
    "name": "Customer Satisfaction Survey",
    "title": "Customer Satisfaction Survey 2023",
    "status": "active",
    "experimental": true,
    "subjectType": [
      "Patient",
      "Practitioner"
    ],
    "date": "2023-01-01T00:00:00Z",
    "publisher": "Health Organization",
    "description": "This survey is intended to gather feedback on customer satisfaction.",
    "purpose": "To improve customer service",
    "copyRight": "© 2023 Health Organization",
    "approvalDate": "2023-01-01T00:00:00Z",
    "lastReviewDate": "2023-01-01T00:00:00Z",
    "effectivePeriod": {
      "start": "2023-01-01T00:00:00Z",
      "end": "2023-12-31T23:59:59Z"
    },
    "item": [
      {
        "question": "How satisfied are you with our service?"
      }
    ],
    "text": "Please answer the following questions.",
    "meta": {
      "versionId": "1",
      "lastUpdated": "2023-01-01T00:00:00Z"
    },
    "contained": [],
    "implicitRules": "http://example.com/rules",
    "language": "en",
    "identifier": [
      {
        "system": "http://example.com",
        "value": "12345"
      }
    ],
    "derivedFrom": [
      "http://example.com/source1",
      "http://example.com/source2"
    ],
    "contact": [
      {
        "name": "John Doe",
        "email": "[email protected]"
      }
    ],
    "useContext": [
      {
        "code": "context1",
        "display": "Context 1"
      }
    ],
    "jurisdiction": [
      {
        "code": "US",
        "display": "United States"
      }
    ],
    "code": [
      {
        "code": "code1",
        "display": "Code 1"
      }
    ],
    "extension": [
      {
        "url": "http://example.com/extension",
        "value": "extensionValue"
      }
    ],
    "attributes": {
      "attribute1": "value1",
      "attribute2": "value2"
    },
    "contentHtml": "<h1>Survey Content</h1>",
    "rewardAmount": null
  }
]

Create a survey

post

Create a new survey

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

idstringOptional

The unique identifier of the survey

Example: 12345

isConsentbooleanOptional

Indicates if its consent

Example: true

resourceTypestringOptional

userTypestring · enumOptional

Who can fill in the survey

Example: CONSUMERPossible values:

organizationIdnumberOptional

The ID of the organization

Example: 1

urlstringOptional

The URL of the survey

Example: http://example.com

versionstringOptional

The version of the survey

Example: 1.0

namestringOptional

The name of the survey

Example: Customer Satisfaction Survey

titlestringOptional

publisherstringOptional

The publisher of the survey

Example: Survey Publisher

descriptionstringOptional

The description of the survey

Example: This survey is about customer satisfaction.

purposestringOptional

The purpose of the survey

Example: To gather customer feedback

copyRightstringOptional

The copyright information of the survey

Example: © 2023 Survey Publisher

implicitRulesstringOptional

The implicit rules of the survey

Example: Some rules

languagestringOptional

The language of the survey

Example: en

statusstring · enumRequired

The status of the survey

Default: draftExample: draftPossible values:

experimentalbooleanOptional

Indicates if the survey is experimental

Example: true

approvalDateone ofOptional

The approval date of the survey

Example: 2023-01-01

string · dateOptional

or

string · date-timeOptional

lastReviewDateone ofOptional

The last review date of the survey

Example: 2023-01-01

string · dateOptional

or

string · date-timeOptional

dateone ofOptional

The date of the survey

Example: 2023-01-01

string · dateOptional

or

string · date-timeOptional

derivedFromstring[]Optional

The derived from information

Default: []Example: ["source1","source2"]

subjectTypestring[]Optional

The subject type of the survey

Default: []Example: ["Patient","Practitioner"]

effectivePeriodanyOptional

The effective period of the survey

Default: {}Example: {"start":"2023-01-01","end":"2023-12-31"}

textanyOptional

The text of the survey

Example: Some text

metaanyOptional

The meta information of the survey

Default: {}Example: {"versionId":"1","lastUpdated":"2023-01-01"}

attributesobjectOptional

The attributes of the survey

Default: {}Example: {"attribute1":"value1"}

Responses

200Success

application/json

post

/api/surveys

HTTPcURLJavaScriptPython

POST /api/surveys HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1329

{
  "id": "12345",
  "isConsent": true,
  "resourceType": "text",
  "userType": "CONSUMER",
  "organizationId": 1,
  "url": "http://example.com",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "text",
  "publisher": "Survey Publisher",
  "description": "This survey is about customer satisfaction.",
  "purpose": "To gather customer feedback",
  "copyRight": "© 2023 Survey Publisher",
  "implicitRules": "Some rules",
  "language": "en",
  "status": "draft",
  "experimental": true,
  "approvalDate": "2023-01-01",
  "lastReviewDate": "2023-01-01",
  "date": "2023-01-01",
  "derivedFrom": [
    "source1",
    "source2"
  ],
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "effectivePeriod": {
    "start": "2023-01-01",
    "end": "2023-12-31"
  },
  "text": "Some text",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01"
  },
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "contained": [
    {
      "resourceType": "Observation",
      "id": "obs1"
    }
  ],
  "contact": [
    {
      "name": "John Doe",
      "telecom": [
        {
          "system": "phone",
          "value": "123-456-7890"
        }
      ]
    }
  ],
  "useContext": [
    {
      "code": {
        "system": "http://example.com",
        "code": "context1"
      }
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://example.com",
          "code": "US"
        }
      ]
    }
  ],
  "code": [
    {
      "system": "http://example.com",
      "code": "code1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com",
      "valueString": "extension1"
    }
  ],
  "item": [
    {
      "linkId": "1",
      "text": "Question 1"
    }
  ],
  "attributes": {
    "attribute1": "value1"
  },
  "contentHtml": [
    "Content 1",
    "Content 2"
  ]
}

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

Get a survey

get

Retrieve a specific survey by ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

surveyIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/surveys/{surveyId}

HTTPcURLJavaScriptPython

GET /api/surveys/{surveyId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

Update a survey

put

Update an existing survey

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

surveyIdstringRequiredPattern: [^\/#\?]+?

Body

application/json

idstringOptional

The unique identifier of the survey

Example: 12345

isConsentbooleanOptional

Indicates if its consent

Example: true

resourceTypestringOptional

userTypestring · enumOptional

Who can fill in the survey

Example: CONSUMERPossible values:

organizationIdnumberOptional

The ID of the organization

Example: 1

urlstringOptional

The URL of the survey

Example: http://example.com

versionstringOptional

The version of the survey

Example: 1.0

namestringOptional

The name of the survey

Example: Customer Satisfaction Survey

titlestringOptional

publisherstringOptional

The publisher of the survey

Example: Survey Publisher

descriptionstringOptional

The description of the survey

Example: This survey is about customer satisfaction.

purposestringOptional

The purpose of the survey

Example: To gather customer feedback

copyRightstringOptional

The copyright information of the survey

Example: © 2023 Survey Publisher

implicitRulesstringOptional

The implicit rules of the survey

Example: Some rules

languagestringOptional

The language of the survey

Example: en

statusstring · enumRequired

The status of the survey

Default: draftExample: draftPossible values:

experimentalbooleanOptional

Indicates if the survey is experimental

Example: true

approvalDateone ofOptional

The approval date of the survey

Example: 2023-01-01

string · dateOptional

or

string · date-timeOptional

lastReviewDateone ofOptional

The last review date of the survey

Example: 2023-01-01

string · dateOptional

or

string · date-timeOptional

dateone ofOptional

The date of the survey

Example: 2023-01-01

string · dateOptional

or

string · date-timeOptional

derivedFromstring[]Optional

The derived from information

Default: []Example: ["source1","source2"]

subjectTypestring[]Optional

The subject type of the survey

Default: []Example: ["Patient","Practitioner"]

effectivePeriodanyOptional

The effective period of the survey

Default: {}Example: {"start":"2023-01-01","end":"2023-12-31"}

textanyOptional

The text of the survey

Example: Some text

metaanyOptional

The meta information of the survey

Default: {}Example: {"versionId":"1","lastUpdated":"2023-01-01"}

attributesobjectOptional

The attributes of the survey

Default: {}Example: {"attribute1":"value1"}

Responses

200Success

application/json

put

/api/surveys/{surveyId}

HTTPcURLJavaScriptPython

PUT /api/surveys/{surveyId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1329

{
  "id": "12345",
  "isConsent": true,
  "resourceType": "text",
  "userType": "CONSUMER",
  "organizationId": 1,
  "url": "http://example.com",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "text",
  "publisher": "Survey Publisher",
  "description": "This survey is about customer satisfaction.",
  "purpose": "To gather customer feedback",
  "copyRight": "© 2023 Survey Publisher",
  "implicitRules": "Some rules",
  "language": "en",
  "status": "draft",
  "experimental": true,
  "approvalDate": "2023-01-01",
  "lastReviewDate": "2023-01-01",
  "date": "2023-01-01",
  "derivedFrom": [
    "source1",
    "source2"
  ],
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "effectivePeriod": {
    "start": "2023-01-01",
    "end": "2023-12-31"
  },
  "text": "Some text",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01"
  },
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "contained": [
    {
      "resourceType": "Observation",
      "id": "obs1"
    }
  ],
  "contact": [
    {
      "name": "John Doe",
      "telecom": [
        {
          "system": "phone",
          "value": "123-456-7890"
        }
      ]
    }
  ],
  "useContext": [
    {
      "code": {
        "system": "http://example.com",
        "code": "context1"
      }
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://example.com",
          "code": "US"
        }
      ]
    }
  ],
  "code": [
    {
      "system": "http://example.com",
      "code": "code1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com",
      "valueString": "extension1"
    }
  ],
  "item": [
    {
      "linkId": "1",
      "text": "Question 1"
    }
  ],
  "attributes": {
    "attribute1": "value1"
  },
  "contentHtml": [
    "Content 1",
    "Content 2"
  ]
}

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}

Delete a survey

delete

Delete an existing survey

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

surveyIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/surveys/{surveyId}

HTTPcURLJavaScriptPython

DELETE /api/surveys/{surveyId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 12,
  "isConsent": true,
  "resourceType": "Survey",
  "userType": "CONSUMER",
  "organizationId": 123,
  "url": "http://example.com/survey",
  "version": "1.0",
  "name": "Customer Satisfaction Survey",
  "title": "Customer Satisfaction Survey 2023",
  "status": "active",
  "experimental": true,
  "subjectType": [
    "Patient",
    "Practitioner"
  ],
  "date": "2023-01-01T00:00:00Z",
  "publisher": "Health Organization",
  "description": "This survey is intended to gather feedback on customer satisfaction.",
  "purpose": "To improve customer service",
  "copyRight": "© 2023 Health Organization",
  "approvalDate": "2023-01-01T00:00:00Z",
  "lastReviewDate": "2023-01-01T00:00:00Z",
  "effectivePeriod": {
    "start": "2023-01-01T00:00:00Z",
    "end": "2023-12-31T23:59:59Z"
  },
  "item": [
    {
      "question": "How satisfied are you with our service?"
    }
  ],
  "text": "Please answer the following questions.",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2023-01-01T00:00:00Z"
  },
  "contained": [],
  "implicitRules": "http://example.com/rules",
  "language": "en",
  "identifier": [
    {
      "system": "http://example.com",
      "value": "12345"
    }
  ],
  "derivedFrom": [
    "http://example.com/source1",
    "http://example.com/source2"
  ],
  "contact": [
    {
      "name": "John Doe",
      "email": "[email protected]"
    }
  ],
  "useContext": [
    {
      "code": "context1",
      "display": "Context 1"
    }
  ],
  "jurisdiction": [
    {
      "code": "US",
      "display": "United States"
    }
  ],
  "code": [
    {
      "code": "code1",
      "display": "Code 1"
    }
  ],
  "extension": [
    {
      "url": "http://example.com/extension",
      "value": "extensionValue"
    }
  ],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  },
  "contentHtml": "<h1>Survey Content</h1>",
  "rewardAmount": null
}