API Name: put-screening
This API creates the Project Silver Screen (PSS) questionnaire response.
Specification
| Endpoint | [baseurl]/QuestionnaireResponse/$put-screening |
|---|---|
| Protocol | HTTPS |
| HTTP Method | Post |
| HTTP Header | Content-Type: application/fhir+json |
Request Body
Remarks:
- (All Slices) is an automatically generated section and should be ignored. Do not pass this as an input parameter. It will also not be part of response.
QuestionnaireResponse
| QuestionnaireResponse | C | QuestionnaireResponse | There are no (further) constraints on this element Element idQuestionnaireResponseShort description A structured set of questions and their answers Alternate namesForm, QuestionnaireAnswers DefinitionA structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the questionnaire being responded to. The QuestionnaireResponse contains enough information about the questions asked and their organization that it can be interpreted somewhat independently from the Questionnaire it is based on. I.e. You don't need access to the Questionnaire in order to extract basic information from a QuestionnaireResponse.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idQuestionnaireResponse.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaireResponse.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaireResponse.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). IETF language tag for a human language
| |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idQuestionnaireResponse.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: dom-6 Constraints
|
| contained | C | 0..* | Resource | There are no (further) constraints on this element Element idQuestionnaireResponse.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings
|
| extension | C | 0..* | Extension | Element idQuestionnaireResponse.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
| code | C | 0..1 | Extension(Coding) | Element idQuestionnaireResponse.extension:codeShort description identify the assessment type Alternate namesextensions, user content Definitionidentify the assessment type There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentType Constraints
|
| id | 0..1 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentTypeMappings
| |
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.extension:code.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). AssessmentTypeValueSet (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ext-1 Constraints
|
| valueCoding | Coding | There are no (further) constraints on this element Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.extension:code.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | Element idQuestionnaireResponse.extension:code.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Project Silver Screen pss-screenMappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.extension:code.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| identifier | Σ | 1..1 | Identifier | There are no (further) constraints on this element Element idQuestionnaireResponse.identifierShort description Business identifier for this set of answers DefinitionBusiness identifiers assigned to this questionnaire response by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server. Allows identification of the questionnaire response as it is known by various participating systems and in a way that remains consistent across servers. Note: This is a business identifier, not a resource identifier (see discussion).
|
| basedOn | Σ | 0..0 | Reference(CarePlan | ServiceRequest) | There are no (further) constraints on this element Element idQuestionnaireResponse.basedOnShort description Request fulfilled by this QuestionnaireResponse Alternate namesorder DefinitionA plan, proposal or order that is fulfilled in whole or in part by this questionnaire response. For example, a ServiceRequest seeking an intake assessment or a decision support recommendation to assess for post-partum depression. Supports traceability of responsibility for the questionnaire response and allows linkage of the response to the proposals/recommendations acted upon. Reference(CarePlan | ServiceRequest) Constraints
|
| partOf | Σ | 0..0 | Reference(Observation | Procedure) | There are no (further) constraints on this element Element idQuestionnaireResponse.partOfShort description Part of referenced event DefinitionA procedure or observation that this questionnaire was performed as part of the execution of. For example, the surgery a checklist was executed as part of. Not to be used to link an questionnaire response to an Encounter - use 'context' for that. Composition of questionnaire responses will be handled using the Assemble operation defined in the SDC IG. For relationships to referrals, and other types of requests, use basedOn. Reference(Observation | Procedure) Constraints
|
| questionnaire | Σ | 1..1 | canonical(Questionnaire) | There are no (further) constraints on this element Element idQuestionnaireResponse.questionnaireShort description Canonical URL of Questionnaire being answered Alternate namesForm DefinitionThe Questionnaire that defines and organizes the questions for which answers are being provided. Needed to allow editing of the questionnaire response in a manner that enforces the constraints of the original form. If a QuestionnaireResponse references a Questionnaire that can be resolved, then the QuestionnaireResponse structure must be consistent with the Questionnaire (i.e. questions must be organized into the same groups, nested questions must still be nested, etc.). It is possible to have a QuestionnaireResponse whose 'questionnaire' element does not resolve. It is also possible for the questionnaire element to not have a value but only extensions (e.g. conveying the title or identifier for the questionnaire). This may happen for legacy data. If there is no formally defined Questionnaire, it is undefined what the 'correct' values for the linkId elements should be and it is possible that linkIds might be inconsistent for QuestionnaireResponses for the same form if captured by distinct systems.
|
| status | Σ ?! | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaireResponse.statusShort description in-progress | completed | amended | entered-in-error | stopped DefinitionThe current state of the questionnaire response. The information on Questionnaire resources may possibly be gathered during multiple sessions and altered after considered being finished. Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. Lifecycle status of the questionnaire response. QuestionnaireResponseStatus (required) Constraints
|
| subject | Σ | 1..1 | Reference(Patient) | Element idQuestionnaireResponse.subjectShort description The subject of the questions Alternate namesPatient, Focus DefinitionThe subject of the questionnaire response. This could be a patient, organization, practitioner, device, etc. This is who/what the answers apply to, but is not necessarily the source of information. Links the questionnaire response to the Patient context. May also affect access control. If the Questionnaire declared a subjectType, the resource pointed to by this element must be an instance of one of the listed types.
|
| encounter | Σ | 0..1 | Reference(Encounter) | Element idQuestionnaireResponse.encounterShort description Encounter the questionnaire response is part of DefinitionThe Encounter during which this questionnaire response was created or to which the creation of this record is tightly associated. Links the questionnaire response to the Encounter context. May also affect access control. This will typically be the encounter the questionnaire response was created during, but some questionnaire responses may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission forms). A questionnaire that was initiated during an encounter but not fully completed during the encounter would still generally be associated with the encounter.
|
| authored | Σ | 1..1 | dateTime | There are no (further) constraints on this element Element idQuestionnaireResponse.authoredShort description Date the answers were gathered Alternate namesDate Created, Date published, Date Issued, Date updated DefinitionThe date and/or time that this questionnaire response was last modified by the user - e.g. changing answers or revising status. Clinicians need to be able to check the date that the information in the questionnaire was collected, to derive the context of the answers. May be different from the lastUpdateTime of the resource itself, because that reflects when the data was known to the server, not when the data was captured. This element is optional to allow for systems that might not know the value, however it SHOULD be populated if possible.
|
| author | Σ | 0..0 | Reference(Practitioner | Patient | Organization) | Element idQuestionnaireResponse.authorShort description The individual or device that received and recorded the answers Alternate namesLaboratory, Service, Practitioner, Department, Company, Performer DefinitionThe individual or device that received the answers to the questions in the QuestionnaireResponse and recorded them in the system. Need to know who interpreted the subject's answers to the questions in the questionnaire, and selected the appropriate options for answers. Mapping a subject's answers to multiple choice options and determining what to put in the textual answer is a matter of interpretation. Authoring by device would indicate that some portion of the questionnaire had been auto-populated. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance. Reference(Practitioner | Patient | Organization) Constraints
|
| source | Σ | 0..0 | Reference(Patient | Practitioner | Organization) | Element idQuestionnaireResponse.sourceShort description The individual or device that answered the questions DefinitionThe individual or device that answered the questions about the subject. When answering questions about a subject that is minor, incapable of answering or an animal, another human source may answer the questions. If not specified, no inference can be made about who provided the data. Device should only be used if it directly determined the answers, not if it was merely used as a capture tool to record answers provided by others. In the latter case, information about the physical device, software, etc. would be captured using Provenance. Reference(Patient | Practitioner | Organization) Constraints
|
| item | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaireResponse.itemShort description Groups and questions DefinitionA group or question item from the original questionnaire for which answers are provided. Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).\nWhen dealing with repeating items, each group repetition will be handled by a separate item. However, repeating questions are handled with a single question item and potentially multiple answers.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | Element idQuestionnaireResponse.item.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
|
| assessmentItemType | C | 0..1 | Extension(Coding) | Element idQuestionnaireResponse.item.extension:assessmentItemTypeShort description Identify the assessment item type Alternate namesextensions, user content DefinitionIdentify the assessment item type There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemTypeMappings
| |
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). AssessmentItemTypeValueSet (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ext-1 Constraints
|
| valueCoding | Coding | There are no (further) constraints on this element Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-item-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Oral Screening oralMappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:assessmentItemType.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| testType | C | 0..1 | Extension(Coding) | Element idQuestionnaireResponse.item.extension:testTypeShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemType Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. https://fhir.synapxe.sg/StructureDefinition/ExtensionAssessmentItemTypeMappings
| |
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.item.extension:testType.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). The cardinality or value of this element may be affected by these constraints: ext-1 Constraints
|
| valueCoding | Coding | There are no (further) constraints on this element Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.extension:testType.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/test-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.extension:testType.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| linkId | C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.linkIdShort description Pointer to specific item from Questionnaire DefinitionThe item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource. Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier. The cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
|
| definition | 0..0 | uri | There are no (further) constraints on this element Element idQuestionnaireResponse.item.definitionShort description ElementDefinition - details for the item DefinitionA reference to an ElementDefinition that provides the details for the item. A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition. The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. There is no need for this element if the item pointed to by the linkId has a definition listed.
| |
| text | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.textShort description Name for group or question text DefinitionText that is displayed above the contents of the group or as the text of the question being answered. Allows the questionnaire response to be read without access to the questionnaire. The text for an item SHOULD be identical to the text from the corresponding Questionnaire.item. This can't be strictly enforced because it's possible for the Questionnaire to be updated subsequent to the QuestionnaireResponse having been created, however the intention is that the text in the QuestionnaireResponse reflects what the user saw when completing the Questionnaire.
| |
| answer | C | 1..* | BackboneElement | Element idQuestionnaireResponse.item.answerShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. Unordered, Open, by $this(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: qrs-1, qrs-2 Constraints
|
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | C | 1..1 | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match. Binding this is problematic because one value set can't apply to both codes and quantities. QuestionnaireAnswerCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
| |
| valueString | string | Data type | ||
| valueCoding | Coding | Data type | ||
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer.itemShort description Child items of question DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Only used when nesting beneath a question - see item.item for nesting beneath groups
| |
| answerYesNo | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNoShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. The cardinality or value of this element may be affected by these constraints: qrs-1, qrs-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.item.answer:answerYesNo.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match. Binding this is problematic because one value set can't apply to both codes and quantities. AssessmentAnswerTypeCodeSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
|
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.answer:answerYesNo.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-answer-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerYesNo.itemShort description Child items of question DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Only used when nesting beneath a question - see item.item for nesting beneath groups
| |
| answerPassRefer | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassReferShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. The cardinality or value of this element may be affected by these constraints: qrs-1, qrs-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | C | 1..1 | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match. Binding this is problematic because one value set can't apply to both codes and quantities. QuestionnaireAnswerCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
| |
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-answer-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerPassRefer.itemShort description Child items of question DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Only used when nesting beneath a question - see item.item for nesting beneath groups
| |
| answerVisualTest | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTestShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. The cardinality or value of this element may be affected by these constraints: qrs-1, qrs-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match. Binding this is problematic because one value set can't apply to both codes and quantities. TestVisualCodeValueSet (required) ConditionsThe cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
|
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
http://loinc.orgMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerVisualTest.itemShort description Child items of question DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Only used when nesting beneath a question - see item.item for nesting beneath groups
| |
| answerHearingTest | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTestShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. The cardinality or value of this element may be affected by these constraints: qrs-1, qrs-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match. Binding this is problematic because one value set can't apply to both codes and quantities. TestHearingCodeValueSet (required) ConditionsThe cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
|
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
http://loinc.orgMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerHearingTest.itemShort description Child items of question DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Only used when nesting beneath a question - see item.item for nesting beneath groups
| |
| answerOralTestDenture | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDentureShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. The cardinality or value of this element may be affected by these constraints: qrs-1, qrs-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match. Binding this is problematic because one value set can't apply to both codes and quantities. PlacementOfDentureValueSet (required) ConditionsThe cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
|
| valueCoding | Coding | Data type | ||
| id | 0..1 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/placement-of-dentureMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestDenture.itemShort description Child items of question DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Only used when nesting beneath a question - see item.item for nesting beneath groups
| |
| answerOralTestOHATStatus | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatusShort description The response(s) to the question DefinitionThe respondent's answer(s) to the question. The value is nested because we cannot have a repeating structure that has variable type. The cardinality or value of this element may be affected by these constraints: qrs-1, qrs-2 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | C | 1..1 | Binding | Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x]Short description Single-valued answer to the question DefinitionThe answer (or one of the answers) provided by the respondent to the question. Ability to retain a single-valued answer to a question. More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire. Note that a question is answered using one of the possible choices defined with answerOption, answerValueSet or some other means and the answer has a complex data type, all elements within the answer in the QuestionnaireResponse SHOULD match the elements defined corresponding choice value in the Questionnaire. However, it is possible that not all elements will be propagated. Also, some systems might use language translations resulting in different displays. Comparison of value to the values defined in the Questionnaire (whether by answerOption, answerValueSet or answerExpression) SHALL NOT pay attention to Coding.display, Reference.display, Quantity.unit unless those are the only elements present. As well, systems are not required to check for a match on any extensions (e.g. ordinal values, translations, etc.). Systems MAY enforce that if extensions such as ordinal values are present in both Questionnaire and QuestionnaireResponse, they match. Binding this is problematic because one value set can't apply to both codes and quantities. The cardinality or value of this element may be affected by these constraints: qrs-2 Constraints
|
| valueCoding | Coding | Data type | ||
| id | 0..1 | id | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/ohat-statusMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.answer:answerOralTestOHATStatus.itemShort description Child items of question DefinitionNested groups and/or questions found within this particular answer. It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details. Only used when nesting beneath a question - see item.item for nesting beneath groups
| |
| item | 0..0 | see (item) | There are no (further) constraints on this element Element idQuestionnaireResponse.item.itemShort description Child items of group item DefinitionSub-questions, sub-groups or display items nested beneath a group. Reports can consist of complex nested groups. Only used when nesting beneath a group - see item.answer.item for nesting beneath questions
|
Terminologies
| Path | Binding Strength | Value Set (Code System) |
|---|---|---|
| QuestionnaireResponse.extension.value[x] | required | https://fhir.synapxe.sg/ValueSet/assessment-type |
| QuestionnaireResponse.item.extension.value[x] | required | https://fhir.synapxe.sg/ValueSet/assessment-item-type |
| QuestionnaireResponse.item.extension.value[x] | required | https://fhir.synapxe.sg/ValueSet/test-type |
| QuestionnaireResponse.item.answer.value[x] | required | https://fhir.synapxe.sg/CodeSystem/assessment-answer-type |
| QuestionnaireResponse.item.answer.value[x] | required | https://fhir.synapxe.sg/ValueSet/test-visual-code |
| QuestionnaireResponse.item.answer.value[x] | required | https://fhir.synapxe.sg/ValueSet/test-hearing-code |
| QuestionnaireResponse.item.answer.value[x] | required | https://fhir.synapxe.sg/ValueSet/placement-of-denture |
| QuestionnaireResponse.item.answer.value[x] | required | https://fhir.synapxe.sg/ValueSet/ohat-status |
Questionnaire
| Questionnaire | C | Questionnaire | There are no (further) constraints on this element Element idQuestionnaireShort description A structured set of questions Alternate namesForm, CRF, Survey DefinitionA structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
| |
| id | Σ | 0..1 | id | There are no (further) constraints on this element Element idQuestionnaire.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idQuestionnaire.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). IETF language tag for a human language
| |
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idQuestionnaire.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. The cardinality or value of this element may be affected by these constraints: dom-6 Constraints
|
| contained | C | 0..* | Resource | There are no (further) constraints on this element Element idQuestionnaire.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. The cardinality or value of this element may be affected by these constraints: dom-2, dom-4, dom-3, dom-5 Mappings
|
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| url | Σ C | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.urlShort description Canonical identifier for this questionnaire, represented as an absolute URI (globally unique) DefinitionAn absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers. Allows the questionnaire to be referenced by a single globally unique identifier. This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.
|
| identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idQuestionnaire.identifierShort description Business identifier for questionnaire DefinitionA formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance. Allows externally provided and/or usable business identifiers to be easily associated with the questionnaire. Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.
|
| version | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.versionShort description Business version of the questionnaire DefinitionThe identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different questionnaires that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format. The version SHOULD NOT contain a '#' - see Business Version.
|
| versionAlgorithm[x] | Σ | 0..1 | Binding | There are no (further) constraints on this element Element idQuestionnaire.versionAlgorithm[x]Short description How to compare versions DefinitionIndicates the mechanism used to compare versions to determine which is more current. If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
|
| versionAlgorithmString | string | There are no (further) constraints on this element Data type | ||
| versionAlgorithmCoding | Coding | There are no (further) constraints on this element Data type | ||
| name | Σ C | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.nameShort description Name for this questionnaire (computer friendly) DefinitionA natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation. Supports code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly. The cardinality or value of this element may be affected by these constraints: cnl-0 Constraints
|
| title | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.titleShort description Name for this questionnaire (human friendly) DefinitionA short, descriptive, user-friendly title for the questionnaire. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
| derivedFrom | Σ | 0..* | canonical(Questionnaire) | There are no (further) constraints on this element Element idQuestionnaire.derivedFromShort description Based on Questionnaire DefinitionThe URL of a Questionnaire that this Questionnaire is based on. Allows a Questionnaire to be created based on another Questionnaire. This element covers a broad range of relationships, from 'somewhat inspired by' to 'fully compliant with'. There is a standard extensionthat allows clearer differentiation between the specifics of the derivation relationship where this is needed - e.g. to determine substitutability and validation expectations - http://hl7.org/fhir/StructureDefinition/questionnaire-derivationType.
|
| status | Σ ?! C | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.statusShort description draft | active | retired | unknown DefinitionThe current state of this questionnaire. Enables tracking the lifecycle of the content and filtering of questionnaires that are appropriate for use versus not. A nominal state-transition diagram can be found in the] documentation Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. See guidance around (not) making local changes to elements here. The lifecycle status of an artifact. The cardinality or value of this element may be affected by these constraints: que-1a Constraints
|
| experimental | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.experimentalShort description For testing purposes, not real usage DefinitionA Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage. Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire. Allows filtering of questionnaires that are appropriate for use versus not. If absent, this resource is treated as though it is not experimental.
|
| subjectType | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.subjectTypeShort description Resource that can be subject of QuestionnaireResponse DefinitionThe types of subjects that can be the subject of responses created for the questionnaire. Allows enforcing that a QuestionnaireResponse only has a .subject element of the appropriate type. If none are specified, then the subject is unlimited. One of the resource types defined as part of this version of FHIR.
|
| date | Σ | 0..0 | dateTime | There are no (further) constraints on this element Element idQuestionnaire.dateShort description Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the questionnaire was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes. The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
|
| publisher | Σ | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.publisherShort description Name of the publisher/steward (organization or individual) DefinitionThe name of the organization or individual responsible for the release and ongoing maintenance of the questionnaire. Helps establish the "authority/credibility" of the questionnaire. May also allow for contact. Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.
|
| contact | Σ | 0..0 | ContactDetail | There are no (further) constraints on this element Element idQuestionnaire.contactShort description Contact details for the publisher DefinitionContact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here.
|
| description | Σ | 0..0 | markdown | There are no (further) constraints on this element Element idQuestionnaire.descriptionShort description Natural language description of the questionnaire DefinitionA free text natural language description of the questionnaire from a consumer's perspective. This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context. (E.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).
|
| useContext | Σ | 0..0 | UsageContext | There are no (further) constraints on this element Element idQuestionnaire.useContextShort description The context that the content is intended to support DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaires. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.
|
| jurisdiction | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idQuestionnaire.jurisdictionShort description Intended jurisdiction for questionnaire (if applicable) DefinitionA legal or geographic region in which the questionnaire is intended to be used. It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.) Countries and regions within which this artifact is targeted for use. JurisdictionValueSet (extensible) Constraints
|
| purpose | 0..0 | markdown | There are no (further) constraints on this element Element idQuestionnaire.purposeShort description Why this questionnaire is defined DefinitionExplanation of why this questionnaire is needed and why it has been designed as it has. This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.
| |
| copyright | 0..0 | markdown | There are no (further) constraints on this element Element idQuestionnaire.copyrightShort description Use and/or publishing restrictions Alternate namesLicense, Restrictions DefinitionA copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire. Consumers of the questionnaire must be able to determine any legal restrictions on the use of the artifact and/or its content.
| |
| copyrightLabel | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.copyrightLabelShort description Copyright holder and year(s) DefinitionA short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). Defines the content expected to be rendered in all representations of the artifact. The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
| |
| approvalDate | 0..0 | date | There are no (further) constraints on this element Element idQuestionnaire.approvalDateShort description When the questionnaire was approved by publisher DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here.
| |
| lastReviewDate | 0..0 | date | There are no (further) constraints on this element Element idQuestionnaire.lastReviewDateShort description When the questionnaire was last reviewed by the publisher DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
| |
| effectivePeriod | Σ | 1..1 | Period | There are no (further) constraints on this element Element idQuestionnaire.effectivePeriodShort description When the questionnaire is expected to be used DefinitionThe period during which the questionnaire content was or is planned to be in active use. Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead. The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a questionnaire intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
|
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.effectivePeriod.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.effectivePeriod.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| start | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idQuestionnaire.effectivePeriod.startShort description Starting time with inclusive boundary DefinitionThe start of the period. The boundary is inclusive. If the low element is missing, the meaning is that the low boundary is not known. The cardinality or value of this element may be affected by these constraints: per-1 Constraints
|
| end | Σ C | 1..1 | dateTime | There are no (further) constraints on this element Element idQuestionnaire.effectivePeriod.endShort description End time with inclusive boundary, if not ongoing DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. If the end of the period is missing, it means that the period is ongoing The cardinality or value of this element may be affected by these constraints: per-1 Constraints
|
| code | Σ | 0..1 | CodingBinding | Element idQuestionnaire.codeShort description Concept that represents the overall questionnaire DefinitionAn identifier for this collection of questions in a particular terminology such as LOINC. Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code. Codes for questionnaires, groups and individual questions. AssessmentTypeValueSet (required) Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.code.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | Element idQuestionnaire.code.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Project Silver Screen pss-screenMappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.code.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| item | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.itemShort description Questions and sections within the Questionnaire DefinitionA particular question, question grouping or display text that is part of the questionnaire. The content of the questionnaire is constructed from an ordered, hierarchical collection of items.
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| linkId | C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.linkIdShort description Unique id for item in questionnaire DefinitionAn identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here. LinkIds can have whitespaces and slashes by design. Tooling should not rely on linkIds being valid XHTML element IDs, and should not directly embed them as such The cardinality or value of this element may be affected by these constraints: que-2 Constraints
|
| definition | 0..0 | uri | There are no (further) constraints on this element Element idQuestionnaire.item.definitionShort description ElementDefinition - details for the item DefinitionThis element is a URI that refers to an ElementDefinition or to an ObservationDefinition that provides information about this item, including information that might otherwise be included in the instance of the Questionnaire resource. A detailed description of the construction of the URI is shown in Comments, below. A common pattern is to define a set of data elements and then build multiple questionnaires for different circumstances to gather the data. This element provides traceability to the common definition and allows the content for the question to come from the underlying definition. The uri refers to an ElementDefinition in a StructureDefinition or to an ObservationDefinition and always starts with the canonical URL for the target resource. When referring to a StructureDefinition, a fragment identifier is used to specify the element definition by its id Element.id. E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. In the absence of a fragment identifier, the first/root element definition in the target is the matching element definition.
| |
| code | C | 0..* | CodingBinding | Element idQuestionnaire.item.codeShort description Corresponding concept for this item in a terminology DefinitionA terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). Allows linking of groups of questions to formal terminologies. The value may come from the ElementDefinition referred to by .definition. Unordered, Open, by $this(Value) BindingCodes for questionnaires, groups and individual questions. AssessmentItemTypeValueSet (required) ConditionsThe cardinality or value of this element may be affected by these constraints: que-3 Constraints
|
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.code.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.code.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.code.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-item-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.code.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.code.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| assessmentItemType | C | 0..1 | CodingBinding | Element idQuestionnaire.item.code:assessmentItemTypeShort description Corresponding concept for this item in a terminology DefinitionA terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). Allows linking of groups of questions to formal terminologies. The value may come from the ElementDefinition referred to by .definition. Codes for questionnaires, groups and individual questions. AssessmentItemTypeCodeSystem (required) ConditionsThe cardinality or value of this element may be affected by these constraints: que-3 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.code:assessmentItemType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.code:assessmentItemType.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.code:assessmentItemType.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-item-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code:assessmentItemType.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.code:assessmentItemType.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code:assessmentItemType.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.code:assessmentItemType.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| testType | C | 0..1 | CodingBinding | Element idQuestionnaire.item.code:testTypeShort description Corresponding concept for this item in a terminology DefinitionA terminology code that corresponds to this group or question (e.g. a code from LOINC, which defines many questions and answers). Allows linking of groups of questions to formal terminologies. The value may come from the ElementDefinition referred to by .definition. observation codes for tests like Snellen, Pinhole, etc The cardinality or value of this element may be affected by these constraints: que-3 Constraints
|
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.code:testType.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.code:testType.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.code:testType.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
http://loinc.orgMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code:testType.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | Element idQuestionnaire.item.code:testType.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Snellen Test (Right eye) snellen-test-right-eyeMappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.code:testType.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.code:testType.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| prefix | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.prefixShort description E.g. "1(a)", "2.5.3" Alternate nameslabel DefinitionA short label for a particular group, question or set of display text within the questionnaire used for reference by the individual completing the questionnaire. Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used. These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically, these won't be used for "display" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.
| |
| text | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.textShort description Primary text for the item DefinitionThe name of a section, the text of a question or text content for a display item. When using this element to represent the name of a section, use group type item and also make sure to limit the text element to a short string suitable for display as a section heading. Group item instructions should be included as a display type item within the group.
| |
| type | C | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.typeShort description group | display | boolean | decimal | integer | date | dateTime + DefinitionThe type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, Coding, etc.). Defines the format in which the user is to be prompted for the answer. Additional constraints on the type of answer can be conveyed by extensions. The value may come from the ElementDefinition referred to by .definition. Distinguishes groups from questions and display text and indicates data type for questions. QuestionnaireItemType (required) ConditionsThe cardinality or value of this element may be affected by these constraints: que-9, que-8, que-6, que-5, que-3, que-10, que-1a, que-1b, que-1c Constraints
|
| enableWhen | ?! C | 0..1 | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhenShort description Only allow data when DefinitionA constraint indicating that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. Allows questionnaires to adapt based on answers to other questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions. If multiple repetitions of this extension are present, the interpretation is driven by enableBehavior (either all repetitions must evaluate to true for this item to be enabled, or only one must evaluate to true for the item to be enabled). If the enableWhen.question has multiple answers, the condition evaluates to true if any of the answers for the referenced item match the enableWhen condition. This element is a modifier because if enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. When an item is disabled, all of its descendants are disabled, regardless of what their own enableWhen logic might evaluate to. If enableWhen logic depends on an item that is disabled, the logic should proceed as though the item is not valued - even if a default value or other value might be retained in memory in the event of the item being re-enabled. In some cases, the comparison between the indicated answer and the specified value may differ only by precision. For example, the enableWhen might be Q1 > 1970, but the answer to Q1 is 1970-10-15. There is not a clear answer as to whether 1970-10-15 should be considered 'greater' than 1970, given that it is an imprecise value. In these indeterminate situations, the form filler has the option of refusing to render the form. If the form is displayed, items where enableWhen is indeterminate SHOULD be treated as enabled with a warning indicating that the questionnaire logic was faulty and it is possible that the item should not be enabled. Questionnaires SHOULD be designed to take into account challenges around varying precision to minimize non-deterministic situations by setting constraints around expected precision, etc. The cardinality or value of this element may be affected by these constraints: que-12 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| question | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.questionShort description The linkId of question that determines whether item is enabled/disabled DefinitionThe linkId for the question whose answer (or lack of answer) governs whether this item is enabled. If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis. If there are multiple items with the same linkId and all are equadistant (e.g. a question references a question that appears in a separate repeating group), that is an error. (Consider using the enableWhenExpression extension to define logic to handle such a situation.)
| |
| operator | C | 1..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.operatorShort description exists | = | != | > | < | >= | <= DefinitionSpecifies the criteria by which the question is enabled. The criteria by which a question is enabled. QuestionnaireItemOperator (required) ConditionsThe cardinality or value of this element may be affected by these constraints: que-7 Constraints
|
| answer[x] | C | 1..1 | There are no (further) constraints on this element Element idQuestionnaire.item.enableWhen.answer[x]Short description Value for question comparison based on operator DefinitionA value that the referenced question is tested using the specified operator in order for the item to be enabled. If there are multiple answers, a match on any of the answers suffices. If different behavior is desired (all must match, at least 2 must match, etc.), consider using the enableWhenExpression extension. Allowed values to answer questions. QuestionnaireAnswerCodes (example) ConditionsThe cardinality or value of this element may be affected by these constraints: que-7 Constraints
| |
| answerCoding | Coding | Data type | ||
| enableBehavior | C | 0..0 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.enableBehaviorShort description all | any DefinitionControls how multiple enableWhen values are interpreted - whether all or any must be true. This element must be specified if more than one enableWhen value is provided. Controls how multiple enableWhen values are interpreted - whether all or any must be true. The cardinality or value of this element may be affected by these constraints: que-12 Constraints
|
| disabledDisplay | 0..0 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.disabledDisplayShort description hidden | protected DefinitionIndicates if and how items that are disabled (because enableWhen evaluates to 'false') should be displayed. If not specified, rendering behavior is up to the client. This element is only meaningful if enableWhen or an equivalent extension is present Defines how disabled elements should be rendered QuestionnaireItemDisabledDisplay (required) Constraints
| |
| required | C | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.requiredShort description Whether the item must be included in data results DefinitionAn indication, if true, that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire. If the required item is a question, it must have a direct answer (i.e. an answer to the question itself, not merely answers to child questions) in order for the QuestionnaireResponse to be complete. If the required item is a group, it must have at least one descendant question which has an answer Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. It also only has meaning if the parent element is present. If a non-required 'group' item contains a 'required' question item, it's completely fine to omit the group (because it's not required) despite it having a required child. Similarly, if an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one descendant item with a populated answer). The value for 'required' may come from the ElementDefinition referred to by .definition. Items are assumed not to be required unless explicitly specified, though extensions may impose additional expectations The cardinality or value of this element may be affected by these constraints: que-6 Constraints
|
| repeats | C | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.repeatsShort description Whether the item may repeat DefinitionAn indication, if true, that a QuestionnaireResponse for this item may include multiple answers associated with a single instance of this item (for question-type items) or multiple repetitions of the item (for group-type items). Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition (i.e. "repeat the question") or to simply allow entry/selection of multiple answers for the question (repeat the answers). Which is most appropriate visually may depend on the type of answer as well as whether there are nested items. The resulting QuestionnaireResponse will be populated the same way regardless of rendering - one 'question' item with multiple answer values. The value may come from the ElementDefinition referred to by .definition. When repeats=true for a group, it'll be represented with multiple items with the same linkId in the QuestionnaireResponse. For a question, it'll be represented by a single item with that linkId with multiple answers. Items are generally assumed not to repeat unless explicitly specified. Systems SHOULD always populate this value The cardinality or value of this element may be affected by these constraints: que-6, que-13 Constraints
|
| readOnly | C | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.readOnlyShort description Don't allow human editing DefinitionAn indication, when true, that the value cannot be changed by a human respondent to the Questionnaire. Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc. If specified on a 'group', then all items beneath the specified group are read only. For questions, this only marks the answer associated with the specific item read only. Descendant questions are not impacted. The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers. The cardinality or value of this element may be affected by these constraints: que-9 Constraints
|
| maxLength | C | 0..0 | integer | There are no (further) constraints on this element Element idQuestionnaire.item.maxLengthShort description No more than these many characters DefinitionThe maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. The value may come from the ElementDefinition referred to by .definition. The cardinality or value of this element may be affected by these constraints: que-10 Constraints
|
| answerConstraint | C | 0..0 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.item.answerConstraintShort description optionsOnly | optionsOrType | optionsOrString DefinitionFor items that have a defined set of allowed answers (via answerOption or answerValueSet), indicates whether values other than those specified can be selected. Introduces the ability for questions to have 'other' answers If not specified, answerConstraint is presumed to be 'optionsOnly' Indicates differnt modes for restricting values when options or valueset are specified QuestionnaireAnswerConstraint (required) ConditionsThe cardinality or value of this element may be affected by these constraints: que-10, que-14 Constraints
|
| answerValueSet | C | 0..0 | canonical(ValueSet) | There are no (further) constraints on this element Element idQuestionnaire.item.answerValueSetShort description ValueSet containing permitted answers DefinitionA reference to a value set containing a list of values representing permitted answers for a question. LOINC defines many useful value sets for questionnaire responses. See LOINC Answer Lists. The value may come from the ElementDefinition referred to by .definition. The cardinality or value of this element may be affected by these constraints: que-5, que-4, que-14 Constraints
|
| answerOption | C | 1..* | BackboneElement | Element idQuestionnaire.item.answerOptionShort description Permitted answer DefinitionOne of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. Unordered, Open, by $this(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: que-5, que-4, que-11, que-14 Constraints
|
| (All Slices) | The requirements in this element apply to all slices | |||
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | 1..1 | Binding | Element idQuestionnaire.item.answerOption.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions. QuestionnaireAnswerCodes (required) Constraints
| |
| valueString | string | Data type | ||
| valueCoding | Coding | Data type | ||
| initialSelected | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Only selected items explicitly marked to be selected
| |
| answerYesNoOption | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOptionShort description Permitted answer DefinitionOne of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. The cardinality or value of this element may be affected by these constraints: que-5, que-4, que-11, que-14 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | 1..1 | Binding | Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions. AssessmentAnswerYesNoValueSet (required) Constraints
| |
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-answer-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| initialSelected | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerYesNoOption.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Only selected items explicitly marked to be selected
| |
| answerVisualTestOption | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOptionShort description Permitted answer DefinitionOne of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. The cardinality or value of this element may be affected by these constraints: que-5, que-4, que-11, que-14 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | 1..1 | Binding | Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions. TestVisualCodeValueSet (required) Constraints
| |
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
http://loinc.orgMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| initialSelected | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerVisualTestOption.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Only selected items explicitly marked to be selected
| |
| answerHearingTestOption | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOptionShort description Permitted answer DefinitionOne of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. The cardinality or value of this element may be affected by these constraints: que-5, que-4, que-11, que-14 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | 1..1 | Binding | Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions. TestHearingCodeValueSet (required) Constraints
| |
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
http://loinc.orgMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| initialSelected | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerHearingTestOption.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Only selected items explicitly marked to be selected
| |
| answerPassReferOption | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOptionShort description Permitted answer DefinitionOne of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. The cardinality or value of this element may be affected by these constraints: que-5, que-4, que-11, que-14 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | 1..1 | Binding | Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions. AssessmentAnswerPassReferValueSet (required) Constraints
| |
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/assessment-answer-typeMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| initialSelected | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerPassReferOption.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Only selected items explicitly marked to be selected
| |
| answerOralTestOptionDenture | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDentureShort description Permitted answer DefinitionOne of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. The cardinality or value of this element may be affected by these constraints: que-5, que-4, que-11, que-14 Constraints
|
| id | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | 1..1 | Binding | Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions. PlacementOfDentureValueSet (required) Constraints
| |
| valueCoding | Coding | Data type | ||
| id | 0..0 | id | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/placement-of-dentureMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
Upper (partial) upper-partialMappings
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| initialSelected | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionDenture.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Only selected items explicitly marked to be selected
| |
| answerOralTestOptionOHATStatus | C | 1..* | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatusShort description Permitted answer DefinitionOne of the permitted answers for the question. This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes. The cardinality or value of this element may be affected by these constraints: que-5, que-4, que-11, que-14 Constraints
|
| id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| modifierExtension | Σ ?! C | 0..0 | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.modifierExtensionShort description Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| value[x] | 1..1 | Binding | Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x]Short description Answer value DefinitionA potential answer that's allowed as the answer to this question. The data type of the value must agree with the item.type. Allowed values to answer questions.
| |
| valueCoding | Coding | Data type | ||
| id | 0..1 | id | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x].idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. The cardinality or value of this element may be affected by these constraints: ele-1 Mappings
| |
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x].extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| system | Σ | 1..1 | uriFixed Value | Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x].systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Need to be unambiguous about the source of the definition of the symbol. The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
https://fhir.synapxe.sg/CodeSystem/ohat-statusMappings
|
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x].versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
|
| code | Σ C | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x].codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| display | Σ C | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x].displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. The cardinality or value of this element may be affected by these constraints: cod-1 Constraints
|
| userSelected | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.value[x].userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
|
| initialSelected | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.item.answerOption:answerOralTestOptionOHATStatus.initialSelectedShort description Whether option is selected by default DefinitionIndicates whether the answer value is selected when the list of possible answers is initially shown. Only selected items explicitly marked to be selected
| |
| initial | C | 0..0 | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item.initialShort description Initial value(s) when item is first rendered DefinitionOne or more values that should be pre-populated in the answer when initially rendering the questionnaire for user input. In some workflows, having defaults saves time. The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. Note that initial values can influence results. The data type of initial.answer[x] must agree with the item.type, and only repeating items can have more then one initial value. The cardinality or value of this element may be affected by these constraints: que-8, que-13, que-11 Constraints
|
| item | 0..* | see (item) | There are no (further) constraints on this element Element idQuestionnaire.item.itemShort description Nested questionnaire items DefinitionText, questions and other groups to be nested beneath a question or group. Reports can consist of complex nested groups. There is no specified limit to the depth of nesting. However, Questionnaire authors are encouraged to consider the impact on the user and user interface of overly deep nesting.
|
Terminologies
| Path | Binding Strength | Value Set (Code System) | Description |
|---|---|---|---|
| Questionnaire.code | required | https://fhir.synapxe.sg/ValueSet/assessment-type | |
| Questionnaire.item.code | required | https://fhir.synapxe.sg/ValueSet/assessment-item-type | |
| Questionnaire.item.code | required | https://fhir.synapxe.sg/CodeSystem/assessment-item-type | |
| Questionnaire.item.code | required | https://fhir.synapxe.sg/ValueSet/test-type | observation codes for tests like Snellen, Pinhole, etc |
| Questionnaire.item.answerOption.value[x] | required | https://fhir.synapxe.sg/ValueSet/assessment-answer-yesno | |
| Questionnaire.item.answerOption.value[x] | required | https://fhir.synapxe.sg/ValueSet/test-visual-code | |
| Questionnaire.item.answerOption.value[x] | required | https://fhir.synapxe.sg/ValueSet/test-hearing-code | |
| Questionnaire.item.answerOption.value[x] | required | https://fhir.synapxe.sg/ValueSet/assessment-answer-passrefer | |
| Questionnaire.item.answerOption.value[x] | required | https://fhir.synapxe.sg/ValueSet/placement-of-denture | |
| Questionnaire.item.answerOption.value[x] | required | https://fhir.synapxe.sg/ValueSet/ohat-status |