{
"description": "This extension is used when defining high-level questionnaires that will then be used as a basis for 'derived' Questionnaires that are further refined for use in specific organizations or contexts. If the extension is present and set to 'true', it means that this item should be considered to be 'optional' from an adaptation perspective and that the question can be removed (i.e. not displayed) in derived questionnaires without impacting the validity of the instrument. Alternatively, the element can be marked as 'hidden' and 'readOnly' and have a value or descendant item values declared using initialValue or initialExpression. If the element with 'optionalDisplay=true' is marked as 'required=true', then this second approach is the only means to exclude the element from display.",
"_filename": "StructureDefinition-sdc-questionnaire-optionalDisplay.json",
"package_name": "hl7.fhir.uv.sdc",
"date": "2024-12-17T01:55:34+00:00",
"derivation": "constraint",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "This was introduced to satisfy requirements from the College of American Pathologists (CAP)",
"name": "OptionalDisplayExtension",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "Extension",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Optional Display?",
"package_version": "4.0.0-ballot",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension",
"min": 0,
"definition": "This extension is used when defining high-level questionnaires that will then be used as a basis for 'derived' Questionnaires that are further refined for use in specific organizations or contexts. If the extension is present and set to 'true', it means that this item should be considered to be 'optional' from an adaptation perspective and that the question can be removed (i.e. not displayed) in derived questionnaires without impacting the validity of the instrument. Alternatively, the element can be marked as 'hidden' and 'readOnly' and have a value or descendant item values declared using initialValue or initialExpression. If the element with 'optionalDisplay=true' is marked as 'required=true', then this second approach is the only means to exclude the element from display.",
"isModifier": false,
"short": "Can suppress from display to user",
"max": "1",
"id": "Extension",
"condition": [ "ele-1" ],
"comment": "If a group or question that contains other groups or questions is marked as \"optional\", all of its contents are automatically also treated as optional.",
"base": {
"max": "*",
"min": 0,
"path": "Extension"
}
}, {
"path": "Extension.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Extension.extension",
"min": 0,
"definition": "An Extension",
"isModifier": false,
"short": "Extension",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "Extension.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"path": "Extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"isModifier": false,
"short": "identifies the meaning of the extension",
"fixedUri": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Extension.url",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Extension.value[x]",
"min": 0,
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
"isModifier": false,
"short": "Value of extension",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Extension.value[x]",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
},
"isSummary": false
} ]
},
"status": "active",
"id": "5ab535c5-ab4a-414e-becb-fd06da7ebc06",
"kind": "complex-type",
"url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.17.42.43",
"system": "urn:ietf:rfc:3986"
} ],
"context": [ {
"type": "element",
"expression": "Questionnaire.item"
} ],
"version": "4.0.0-ballot",
"differential": {
"element": [ {
"id": "Extension",
"max": "1",
"path": "Extension",
"short": "Can suppress from display to user",
"comment": "If a group or question that contains other groups or questions is marked as \"optional\", all of its contents are automatically also treated as optional.",
"definition": "This extension is used when defining high-level questionnaires that will then be used as a basis for 'derived' Questionnaires that are further refined for use in specific organizations or contexts. If the extension is present and set to 'true', it means that this item should be considered to be 'optional' from an adaptation perspective and that the question can be removed (i.e. not displayed) in derived questionnaires without impacting the validity of the instrument. Alternatively, the element can be marked as 'hidden' and 'readOnly' and have a value or descendant item values declared using initialValue or initialExpression. If the element with 'optionalDisplay=true' is marked as 'required=true', then this second approach is the only means to exclude the element from display."
}, {
"id": "Extension.extension",
"max": "0",
"path": "Extension.extension"
}, {
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay"
}, {
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"type": [ {
"code": "boolean"
} ]
} ]
},
"contact": [ {
"name": "HL7 International / FHIR Infrastructure",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}