/
Guidelines

Guidelines

Owned by Erik Nielsen
Last updated: 28-04-2020
2 min read

These pages describe guidelines on using the eHealth API. The guidelines constitute choices on how to use or assign values to certain resources and their elements.

Technical Guidelines

Format of Questionnaire linkId

A FHIR Questionnaire uses a string-based Questionnaire.item.linkId to identify the individual questionnaire groups and questions. This linkId is also referred from the FHIR QuestionnaireResponse.

  1. linkId shall be assigned a value on the form “<root>,<extension>,<assigningAuthorityName>”. Here, <root> shall be an Object Identifier (OID) (See definition on https://www.hl7.org/Oid/information.cfm). The linkId for the example below would be “1.2.208.176.1.5.1,220,Sundhedsdatastyrelsen”.

In case a QuestionnaireResponse must be transferred to the national IHE XDS-based document sharing infrastructure, it is assembled into a document and transformed to a Questionnaire Response Document adhering to the DK-HL7 QRD profile. In this document, the question identifier is on the Instance Identifier form for which an example is given below:

<id assigningAuthorityName="Sundhedsdatastyrelsen" extension="220" root="1.2.208.176.1.5.1"/>

Using the comma encoded form described for the linkId above in FHIR Questionnaire and QuestionnaireResponse, the question identifier can be handled when transforming to and from FHIR.

Default Questionnaire linkId for Questionnaire Originating in eHealth

Whether a questionnaire is originating in the eHealth infrastructure or has been created and defined outside it, the questionnaire linkId within the Questionnaire shall adhere to the format described in Format of Questionnaire linkId.

  1. When a questionnaire is originating in the eHealth infrastructure, it can use the default questionnaire linkId where the <extension> is a unique string not containing comma or white space,<root> is NamingSystem.uniqueId.value (where NamingSystem.uniqueId.type is oid) and <assigningAuthorityName> is NamingSystem.responsible, both from the NamingSystem which can be found with GET https://terminology.{{domain}}/fhir/NamingSystem?value=http://ehealth.sundhed.dk/id/ehealth-question-identifier, where {{domain}} reflects the eHealth environment. Currently, the <root> and <assigningAuthorityName> thereby resolves to 1.2.208.176.7.200.2 and “ehealth.sundhed.dk“, respectively.

Whether the <extension> is, say, a random UUID or a controlled and/or catalogued identifier depends on the context.

 

Related content