Get Form

Get a form and its fields.

SecurityapiKeyAuth and practiceGroupId

Request

path Parameters

required

string

Responses

200

400

Validation error

401

Unauthorised

404

Not found

500

Unknown error

get/v1/forms/{id}

Request samples

curl
Node.js
Ruby

Response samples

application/json

{"id": "string",
"form_type": "questionnaire",
"title": "string",
"description": "string",
"patient_title": "string",
"patient_description": "string",
"snomed_code": "string",
"fields": [{"form_question_id": "string",
"name": "string",
"type": "string",
"observation_name": "systolic_blood_pressure",
"problem_name": "asthmatic",
"immunisation_name": "administration_of_men_a_c_w135_and_y_vaccine",
"hint": "string",
"optional": true,
"text": "string",
"snomed_code": "string",
"options": [{"id": "string",
"value": "string",
"snomed_code": "string"
}
],
"validation": {"date_range_validation": "unrestricted"
},
"conditions": {"display_condition": "show_when",
"cond_type": "is equal to",
"cond_value": "string",
"condition_question_id": "string"
}
}
]
}