Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension: signatureRequired

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired

Status: draft. Extension maintained by: HL7

Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse.

Comment:

If this appears at the Questionnaire level, then the signature will be gathered for the entire form when it is marked complete. If it appears on a particular item, then it will be gathered on that question or group when it is filled in. (E.g. seeking the user's initials beside certain questions.)

The signature can be captured using the http://hl7.org/fhir/StructureDefinition/questionnaireresponse-signature extension. See additional guidance and examples in the SDC implementation guide.

Context of Use: Use on Element ID Questionnaire or Element ID Questionnaire.item

Summary

Name	Flags	Card.	Type	Description & Constraints
signatureRequired		0..*	CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired signatureRequired: Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. Binding: Signature Type Codes (preferred): The type of signature needed. Use on Element ID Questionnaire or Element ID Questionnaire.item
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired signatureRequired: Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. Use on Element ID Questionnaire or Element ID Questionnaire.item
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired"
value[x]	1..1	CodeableConcept	Value of extension Binding: Signature Type Codes (preferred): The type of signature needed.
Documentation for this format

XML Template

<!-- signatureRequired -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // signatureRequired
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired", // R! 
    "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
signatureRequired		0..*	CodeableConcept	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired signatureRequired: Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. Binding: Signature Type Codes (preferred): The type of signature needed. Use on Element ID Questionnaire or Element ID Questionnaire.item
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired signatureRequired: Indicates that a signature (of the specified type) is needed when completing the QuestionnaireResponse. Use on Element ID Questionnaire or Element ID Questionnaire.item
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired"
value[x]	1..1	CodeableConcept	Value of extension Binding: Signature Type Codes (preferred): The type of signature needed.
Documentation for this format

XML Template

<!-- signatureRequired -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired" >
  <!-- from Element: extension -->
 <valueCodeableConcept><!--  1..1 CodeableConcept Value of extension --></valueCodeableConcept>
</extension>

JSON Template

{ // signatureRequired
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-signatureRequired", // R! 
    "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)