ISiKFormularDefinition
Metadaten
| Canonical | https://gematik.de/fhir/isik/StructureDefinition/ISiKFormularDefinition |
|---|---|
| Status | active |
| Version | 5.1.1 |
| Basis | http://hl7.org/fhir/StructureDefinition/Questionnaire |
Inhalt
| ISiKFormularDefinition (Questionnaire) | C | Questionnaire | |
| id | S Σ | 0..1 | string |
| meta | Σ | 0..1 | Meta |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| versionId | Σ | 0..1 | id |
| lastUpdated | Σ | 0..1 | instant |
| source | Σ | 0..1 | uri |
| profile | Σ | 0..* | canonical(StructureDefinition) |
| security | Σ | 0..* | CodingBinding |
| tag | Σ | 0..* | Coding |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | C | 0..* | Extension |
| modifierExtension | ?! C | 0..* | Extension |
| MDR-Relevant | S ?! C | 0..1 | Extension(Coding) |
| url | S Σ | 1..1 | uri |
| identifier | Σ | 0..* | Identifier |
| version | S Σ | 1..1 | string |
| name | Σ C | 0..1 | string |
| title | S Σ | 1..1 | string |
| derivedFrom | 0..* | canonical(Questionnaire) | |
| status | S Σ ?! | 1..1 | codeBinding |
| experimental | Σ | 0..1 | boolean |
| subjectType | S Σ | 1..1 | codeBindingPattern |
| date | Σ | 0..1 | dateTime |
| publisher | Σ | 0..1 | string |
| contact | Σ | 0..* | ContactDetail |
| description | S | 1..1 | markdown |
| useContext | Σ | 0..* | UsageContext |
| jurisdiction | Σ | 0..* | CodeableConceptBinding |
| purpose | 0..1 | markdown | |
| copyright | 0..1 | markdown | |
| approvalDate | 0..1 | date | |
| lastReviewDate | 0..1 | date | |
| effectivePeriod | Σ C | 0..1 | Period |
| code | Σ | 0..* | Coding |
| item | S C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| linkId | S | 1..1 | string |
| definition | 0..1 | uri | |
| code | S C | 0..* | Coding |
| prefix | S | 0..1 | string |
| text | S | 0..1 | string |
| type | S | 1..1 | codeBinding |
| enableWhen | S ?! C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| question | S | 1..1 | string |
| operator | S | 1..1 | codeBinding |
| answer[x] | S C | 1..1 | |
| answerBoolean | boolean | ||
| answerCoding | Coding | ||
| answerDate | date | ||
| answerDateTime | dateTime | ||
| answerDecimal | decimal | ||
| answerInteger | integer | ||
| answerQuantity | Quantity | ||
| answerReference | Reference(Resource) | ||
| answerString | string | ||
| answerTime | time | ||
| enableBehavior | C | 0..1 | codeBinding |
| required | S C | 0..1 | boolean |
| repeats | S C | 0..1 | boolean |
| readOnly | S C | 0..1 | boolean |
| maxLength | S C | 0..1 | integer |
| answerValueSet | S C | 0..1 | canonical(ValueSet) |
| answerOption | S C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| value[x] | 1..1 | ||
| valueCoding | Coding | ||
| valueDate | date | ||
| valueInteger | integer | ||
| valueReference | Reference(Resource) | ||
| valueString | string | ||
| valueTime | time | ||
| initialSelected | 0..1 | boolean | |
| initial | C | 0..* | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| value[x] | 1..1 | ||
| valueAttachment | Attachment | ||
| valueBoolean | boolean | ||
| valueCoding | Coding | ||
| valueDate | date | ||
| valueDateTime | dateTime | ||
| valueDecimal | decimal | ||
| valueInteger | integer | ||
| valueQuantity | Quantity | ||
| valueReference | Reference(Resource) | ||
| valueString | string | ||
| valueTime | time | ||
| valueUri | uri | ||
| item | S C | 0..* | see (item) |
Command 'page' could not render: Page not found.
<description value="Im Profil `ISiKFormularDefinition` sind Mindestanforderungen an ISiK kompatible Formulare definiert.\nDie verwendbaren Extensions sind nicht mit profiliert, sondern im IG unter [Artefakte->Extensions](https://simplifier.net/guide/isik-formular-stufe-5/Einfuehrung/Artefakte/Extensions.page.md?version=current) beschrieben." />
<comment value="**bedingtes Pflichtfeld/bedingtes MS:** Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen. " />
</element>
<comment value="Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine `versionID` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `versionID`verfügen. " />
</element>
<comment value="Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein `lastUpdate` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein `lastUpdate`verfügen. " />
</element>
<comment value="**Begründung MS:**\n In dieser Extension wird angegeben, dass die Formulardaten MDR-relevant sind. Für die Erhebung und/oder Darstellung müssen ggf. bestimmte Voraussetzungen erfüllt sein. Ist die Extension nicht vorhanden, liegt keine MDR-relevanmt vor." />
<profile value="https://gematik.de/fhir/isik/StructureDefinition/ISiKMDRRelevanzFormularExtension" />
</type>
</element>
<comment value="Weltweit eindeutiger Name des Formulars.\n **Begründung Pflichtfeld:**\n Wird für eindeutige Bezugnahme von FormularDaten auf FormularDefinition benötigt." />
</element>
<comment value="Versionsnummer des Formulars. Sollte gem. semVer-Regeln inkrementiert werden, je nach Schweregrad der Änderungen.\n **Begründung MS:** \n Wird benötigt, um FormularDefinitionen in unterschiedlichen Versionen zu differenzieren. " />
</element>
<comment value="Dem Anwender angezeigter Titel des Formulars. \n **Begründung MS:** \n Wird für die Darstellung und Auffindbarkeit der FormularDefinition benötigt." />
</element>
<comment value="Die im ISiK-Kontext bereitgestellten Formulare sollten final ausspezifiziert sein und daher den Status 'active' haben. \n Formulare, die zurückgezogen oder durch neuere Versionen ersetzt wurden, können mit 'retired' gekennzeichnet werden." />
</element>
<comment value="**Begründung Pflichtfeld:** \n Zur Vereinfachung des Workflows werden zunächst nur Formulare mit Patientenbezug zugelassen. \n Dabei ist stets davon auszugehen, dass der Patient, für den dieses Formular ausgefüllt wird, \n identisch ist, mit dem Patient, der im Launch-Kontext übergeben wird. \n Diese Anforderung kann in künftigen Ausbaustufen gelockert werden." />
</element>
<comment value="**Begründung Pflichtfeld:** \n Ausführliche Beschreibung des Formulars zur Verbesserung der Auffindbarkeit und Interpretation der Nutzung" />
</element>
</element>
<comment value="**Begründung Pflichtfeld:** \n Erforderlich für die Verlinkung der Antworten in der QuestionnaireRespons mit der Definition des Formularfeldes." />
</element>
<comment value="**Begründung MS:** \n Zur eindeutigen Identifikation des Formularfeldes. Ohne Code ist Observation-based-extraction nicht möglich.\n Wenn kein Code zur Verfügung steht, besteht weiterhin die Möglichkeit ein Item ohne Code zu definieren." />
</element>
<comment value="**Begründung MS:**\n Falls bspw. eine Gruppierung oder Nummerierung nicht über die Verschachtelung von Items erfolgt, kann über das Prefix eine solche erfolgen. Aus dem Grund MUSS es in der Darstellung beim Rendern mit verarbeitet werden." />
</element>
<comment value="**Begründung MS:** \n Je nach 'type' des items: Fragestellung, Anzeigetext oder Gruppenname" />
</element>
<comment value="Time is handled using "string". File is handled using Attachment. (Content can be sent as a contained binary)." />
</element>
<comment value="**Begründung MS:** Bedingungen, die erfüllt sein müssen, damit das Item dargestellt wird. Dieses Feld ist ein modifier-Element, weshalb MS obligatorisch ist, es muss interpretiert werden." />
</element>
</element>
<comment value="Operator, mittels dem die Value der .question mit dem in answer[x] angegeben Element vergleichen wird." />
</element>
</element>
<comment value="**Begründung MS:** \n FormularRenderer sollen sicherstellen können, dass Formulare vom Anwender vollständig ausgefüllt werden." />
</element>
<comment value="**Begründung MS:** FormularRenderer sollen in der Lage sein zwischen Einfach- und Mehrfachangaben unterscheiden zu können." />
</element>
<comment value="Antwort wird automatisch vorbelegt/berechnet und darf nicht vom Anwender editiert/überschrieben werden.\n **Begründung MS:** Automatisch vorbelegte Items sollen gegen Veränderung durch den Benutzer geschützt werden können (z.B. für Patientenstammdaten)." />
</element>
</element>
<comment value="**Begründung MS:** Wo geeignete ValueSets vorhanden sind, die die Antwortmöglichkeiten hinreichend repräsentieren, sollte auf diese verwiesen werden." />
</element>
<comment value="**Begründung MS:** Wo *keine* geeignete ValueSets vorhanden sind, die die Antwortmöglichkeiten hinreichen repräsentieren, \n können Antworten alternativ in der FormularDefinition explizit aufgezählt werden.." />
</element>
<comment value="**Begründung MS:** \n Items können beliebig verschachtelt und zu Gruppen zusammengefasst werden, um komplexere und umfangreichere Formulare zu strukturieren." />
</element>
</differential>
</StructureDefinition>
{
"description": "Im Profil `ISiKFormularDefinition` sind Mindestanforderungen an ISiK kompatible Formulare definiert.\nDie verwendbaren Extensions sind nicht mit profiliert, sondern im IG unter [Artefakte->Extensions](https://simplifier.net/guide/isik-formular-stufe-5/Einfuehrung/Artefakte/Extensions.page.md?version=current) beschrieben.",
{
"comment": "**bedingtes Pflichtfeld/bedingtes MS:** Alle von einem Server bereitgestellten Ressourcen MÜSSEN über eine `id` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `id`verfügen.",
},
{
"comment": "Alle von einem Server bereitgestellten Ressourcen SOLLEN über eine `versionID` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über eine `versionID`verfügen."
},
{
"comment": "Alle von einem Server bereitgestellten Ressourcen SOLLEN über ein `lastUpdate` verfügen.\n Von Clients erzeugte Ressourcen, die im Kontext einer CREATE-Interaktion übermittelt werden, MÜSSEN NICHT über ein `lastUpdate`verfügen."
},
{
"comment": "**Begründung MS:**\n In dieser Extension wird angegeben, dass die Formulardaten MDR-relevant sind. Für die Erhebung und/oder Darstellung müssen ggf. bestimmte Voraussetzungen erfüllt sein. Ist die Extension nicht vorhanden, liegt keine MDR-relevanmt vor.",
{
"https://gematik.de/fhir/isik/StructureDefinition/ISiKMDRRelevanzFormularExtension"
]
}
],
},
{
"comment": "Weltweit eindeutiger Name des Formulars.\n **Begründung Pflichtfeld:**\n Wird für eindeutige Bezugnahme von FormularDaten auf FormularDefinition benötigt.",
},
{
"comment": "Versionsnummer des Formulars. Sollte gem. semVer-Regeln inkrementiert werden, je nach Schweregrad der Änderungen.\n **Begründung MS:** \n Wird benötigt, um FormularDefinitionen in unterschiedlichen Versionen zu differenzieren.",
},
{
"comment": "Dem Anwender angezeigter Titel des Formulars. \n **Begründung MS:** \n Wird für die Darstellung und Auffindbarkeit der FormularDefinition benötigt.",
},
{
"comment": "Die im ISiK-Kontext bereitgestellten Formulare sollten final ausspezifiziert sein und daher den Status 'active' haben. \n Formulare, die zurückgezogen oder durch neuere Versionen ersetzt wurden, können mit 'retired' gekennzeichnet werden.",
},
{
"comment": "**Begründung Pflichtfeld:** \n Zur Vereinfachung des Workflows werden zunächst nur Formulare mit Patientenbezug zugelassen. \n Dabei ist stets davon auszugehen, dass der Patient, für den dieses Formular ausgefüllt wird, \n identisch ist, mit dem Patient, der im Launch-Kontext übergeben wird. \n Diese Anforderung kann in künftigen Ausbaustufen gelockert werden.",
},
{
"comment": "**Begründung Pflichtfeld:** \n Ausführliche Beschreibung des Formulars zur Verbesserung der Auffindbarkeit und Interpretation der Nutzung",
},
{
},
{
"comment": "**Begründung Pflichtfeld:** \n Erforderlich für die Verlinkung der Antworten in der QuestionnaireRespons mit der Definition des Formularfeldes.",
},
{
"comment": "**Begründung MS:** \n Zur eindeutigen Identifikation des Formularfeldes. Ohne Code ist Observation-based-extraction nicht möglich.\n Wenn kein Code zur Verfügung steht, besteht weiterhin die Möglichkeit ein Item ohne Code zu definieren.",
},
{
"comment": "**Begründung MS:**\n Falls bspw. eine Gruppierung oder Nummerierung nicht über die Verschachtelung von Items erfolgt, kann über das Prefix eine solche erfolgen. Aus dem Grund MUSS es in der Darstellung beim Rendern mit verarbeitet werden.",
},
{
"comment": "**Begründung MS:** \n Je nach 'type' des items: Fragestellung, Anzeigetext oder Gruppenname",
},
{
"comment": "Time is handled using \"string\". File is handled using Attachment. (Content can be sent as a contained binary).",
},
{
"comment": "**Begründung MS:** Bedingungen, die erfüllt sein müssen, damit das Item dargestellt wird. Dieses Feld ist ein modifier-Element, weshalb MS obligatorisch ist, es muss interpretiert werden.",
},
{
},
{
"comment": "Operator, mittels dem die Value der .question mit dem in answer[x] angegeben Element vergleichen wird.",
},
{
},
{
"comment": "**Begründung MS:** \n FormularRenderer sollen sicherstellen können, dass Formulare vom Anwender vollständig ausgefüllt werden.",
},
{
"comment": "**Begründung MS:** FormularRenderer sollen in der Lage sein zwischen Einfach- und Mehrfachangaben unterscheiden zu können.",
},
{
"comment": "Antwort wird automatisch vorbelegt/berechnet und darf nicht vom Anwender editiert/überschrieben werden.\n **Begründung MS:** Automatisch vorbelegte Items sollen gegen Veränderung durch den Benutzer geschützt werden können (z.B. für Patientenstammdaten).",
},
{
},
{
"comment": "**Begründung MS:** Wo geeignete ValueSets vorhanden sind, die die Antwortmöglichkeiten hinreichend repräsentieren, sollte auf diese verwiesen werden.",
},
{
"comment": "**Begründung MS:** Wo *keine* geeignete ValueSets vorhanden sind, die die Antwortmöglichkeiten hinreichen repräsentieren, \n können Antworten alternativ in der FormularDefinition explizit aufgezählt werden..",
},
{
"comment": "**Begründung MS:** \n Items können beliebig verschachtelt und zu Gruppen zusammengefasst werden, um komplexere und umfangreichere Formulare zu strukturieren.",
}
]
}
}