Finnish PHR Questionnaire profile
NB! Software clients integrated to Kanta PHR can store a Questionnaire resource to Kanta PHR themselves only in the sandbox environments. In all other environments, Questionnaire resources are stored to Kanta PHR by Kela.
Finnish PHR profile for FHIR® Questionnaire. The Questionnaire is an organized collection of questions intended to solicit information from patients. Read more about the FHIR Questionnaire (hl7.org)
This profile only defines the structures used in questionnaires, not the actual content of the questionnaires. All the Questionnaires stored in Finnish PHR must follow these structures and profiling done to the elements of the resource.
A full list of the extensions, constraints and a structured definition of this profile can be found in Simplifier. There are also different views of the profile (details, mappings, table, XML, JSON).
Please, see also the Finnish PHR Profiling Guidelines for more instructions related to creating a Finnish PHR Questionnaire resource.
Mandatory elements for Finnish PHR Questionnaires
| Content | Name in structure | Description / Type of information |
|---|---|---|
| URI used to refer to this questionnaire | url | An absolute URI that is used to identify this questionnaire when it is referenced for example from QuestionnaireResponses. The URI SHOULD be globally unique and SHOULD include the major (business) version of the Questionnaire. |
| Unique identifier | identifier | At least one globally unique identifier has to be provided for the observation, in addition other identifiers may be given as well. This identifier may be used to uniquely identify the observation if the application doesn't receive an id for the observation provided by Kanta PHR. |
| Business version | version | Indicates the business version of the questionnaire. The url of the Questionnaire SHOULD include the major version of the Questionnaire. |
| Name | name | A computer friendly name of the questionnaire. The name is not expected to be globally unique. |
| Title | title | A human friendly name of the questionnaire. |
| Status | status | Indicates whether the Questionnaire is a draft, active or retired. The code for status SHALL be from the FHIR Publication Status ValueSet. Read more about the publication status valueset. - In testing phase, the status SHALL be 'draft'. - When active in production, the status SHALL be 'active'. - When a Questionnaire for example superseded by a newer version, the status SHALL be 'retired'. |
| Publication date | date | The date (and optionally time) when the questionnaire was published or changed. |
| Description | description | A free text natural language description of the questionnaire from a consumer's perspective. |
| Code for the questionnaire | code | Identifies the questionnaire. There is a possibility to use multiple codes in this element. One of the code SHALL be from the Questionnaire code valueset. Read more about the Finnish PHR Questionnaire Code ValueSet. - Each different kind of a Questionnaire shall have its own code. - Different language versions of the same Questionnaire may have the same code (in case a separate Questionnaire instance is created for each different language). |
| Questions and sections | item | This structure includes all the display items, question groups and questions of the questionnaire. |
Optional elements for Finnish PHR Questionnaires
| Content | Name in structure | Description / Type of information |
|---|---|---|
| Language | language | Language of the Questionnaire. Language SHALL be chosen from the FHIR languages ValueSet. Read more about the FHIR languages ValueSet. - A language SHALL be given, if the Questionnaire is only in a single language. - If the Questionnaire includes several languages in the same resource, no language SHALL be given. |
| For testing purposes | experimental | A boolean value to indicate that this questionnaire is authored for testing purposes. |
| Name of the publisher | publisher | The name of the individual or organization that published the questionnaire. |
| Purpose | purpose | Explanation of why this questionnaire is needed. |
| Approval date | approvalDate | When was this questionnaire accepted by the publisher. |
| Date of last review | lastReviewDate | The date on which the questionnaire content was last reviewed. |
| When to use the questionnaire | effectivePeriod | The period during which the questionnaire content was or is planned to be in active use. |
| Publisher's contact information | contact | Contact details to assist in communicating with the publisher. |
| Copyright | copyright | A copyright statement relating to the questionnaire and/or its contents. |
| What or who the questionnaire is about | subjectType | Indicates what type the subject of the questionnaire response is (who or what the questionnaire response is about). The code SHALL always be 'Patient' from the FHIR Resource Type ValueSet. Read more about the FHIR Resource Type ValueSet. In Kanta PHR the questionnaire responses are always about a patient/citizen. |
Elements in the Questionnaire profile filled by the Kanta PHR platform
| Content | Name in structure | Description / Type of information |
|---|---|---|
| Application that created or updated the resource | extension: creatingApplication |
Is used to represent information about the application (id and name) that created or updated the resource. See the definition for theFinnish PHR Application Information extension. Kanta PHR platform will fill in this data automatically to each stored resource (if the application has entered some data in this extension, it will be overwitten). |