ovok_sdk.resources.questionnaires

Questionnaire population and QuestionnaireResponse submission and extraction.

QuestionnairesResourceCopy Anchor Link

QuestionnairesResource(http: HttpClient)

Questionnaire operations. Created by Ovok; access it as ovok.questionnaires.

populate()Copy Anchor Link

populate(questionnaire_id: str, parameters: Resource | None = None) -> Resource

Populate a Questionnaire into a draft QuestionnaireResponse with FHIR $populate.

Parameters

Returns

• Resource: The $populate result, usually Parameters holding the QuestionnaireResponse.

QuestionnaireResponsesResourceCopy Anchor Link

QuestionnaireResponsesResource(http: HttpClient, fhir: FhirResource)

Submits and extracts QuestionnaireResponses.

Created by Ovok; access it as ovok.questionnaire_responses.

submit()Copy Anchor Link

submit(response: Resource) -> Resource

Create a QuestionnaireResponse in a transaction Bundle.

Parameters

Returns

• Resource: The transaction-response Bundle.

submit_with_observations()Copy Anchor Link

submit_with_observations(response: Resource, observations: list[Resource]) -> Resource

Create a QuestionnaireResponse and its Observations in one transaction.

A resource with an id is sent with that fullUrl, so the others can reference it.

Parameters

Returns

• Resource: The transaction-response Bundle.

extract()Copy Anchor Link

extract(response_id: str) -> Resource

Extract resources from a stored QuestionnaireResponse with FHIR $extract.

Parameters

Returns

• Resource: The $extract result.