QuestionnaireSeLite
Introduction
QuestionnaireSeLite is created from the FHIR resource Questionnaire.
Intended Use
Intended use for the QuestionnaireSeLite profile is to apply for searching out a list of Questionnaires with limited contents (i.e. items are not included). This is done by providing one or several codes as the search parameter. The bundled list that is retrieved from the search should be used to get an overview of available Questionnaires, which complete contents can later be retrieved through QuestionnaireSe.
Specific Rules and Limitations
Type | Description |
---|---|
Rule | It is mandatory to provide one or several codings to be able to retrieve any Questionnaires through the API. |
Rule | It is mandatory for the Questionnaire to have a name (title) to be able to retrieve the Questionnaire. |
Rule | It is mandatory to use the Snomed code for Patient (16154003) when retrieving questionnaires for patient use. If this code is not specified, the API will return healthcare professional templates. |
Rule | To request healthcare professional templates, the Snomed code for Healthcare professional (223366009) is used. |
Rule | The useContext for patient should only be used for this API. Only templates that have been agreed on should be used. |
Limitation | Only one of the template contexts patient/healthcare professional can be requested at the time. |
Profile Overview
QuestionnaireSeLite (Questionnaire) | I | QuestionnaireSe | There are no (further) constraints on this element Element idQuestionnaire 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 | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.id 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. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idQuestionnaire.meta 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.meta.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.meta.extension 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 manageable, 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
|
versionId | Σ | 0..1 | id | There are no (further) constraints on this element Element idQuestionnaire.meta.versionId Version specific identifier DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
|
lastUpdated | Σ | 0..1 | instant | There are no (further) constraints on this element Element idQuestionnaire.meta.lastUpdated When the resource version last changed DefinitionWhen the resource last changed - e.g. when the version changed. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.
|
source | Σ | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.meta.source Identifies where the resource comes from DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
|
profile | Σ | 1..1 | canonical(StructureDefinition) | There are no (further) constraints on this element Element idQuestionnaire.meta.profile Profiles this resource claims to conform to DefinitionA list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. canonical(StructureDefinition) Constraints
|
security | Σ | 0..* | CodingBinding | There are no (further) constraints on this element Element idQuestionnaire.meta.security Security Labels applied to this resource DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. Security Labels from the Healthcare Privacy and Security Classification System.
|
tag | Σ | 0..* | Coding | There are no (further) constraints on this element Element idQuestionnaire.meta.tag Tags applied to this resource DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.implicitRules 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 it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.language 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). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idQuestionnaire.text 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 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.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idQuestionnaire.contained 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, and nor can they have their own independent transaction scope. 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.extension 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 manageable, 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
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.modifierExtension 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 manageable, 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
url | Σ | 1..1 | uri | There are no (further) constraints on this element Element idQuestionnaire.url Canonical identifier for this questionnaire, represented as a 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 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. … This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for. The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.
|
identifier | Σ | 0..0 | Identifier | There are no (further) constraints on this element Element idQuestionnaire.identifier Additional identifier for the 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 module. 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 | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.version 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 migVht 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 questionnaire instances that have the same identifier 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 [url]|[version].
|
name | Σ I | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.name 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. Support human navigation and code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
|
title | Σ | 1..1 | string | There are no (further) constraints on this element Element idQuestionnaire.title Name for this questionnaire (human friendly) DefinitionThe name of the questionnaire/ journal note template. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
|
derivedFrom | 0..0 | canonical(Questionnaire) | There are no (further) constraints on this element Element idQuestionnaire.derivedFrom Instantiates protocol or definition DefinitionThe URL of a Questionnaire that this Questionnaire is based on. Allows a Questionnaire to be created based on another Questionnaire.
| |
status | Σ ?! | 1..1 | codeBindingFixed Value | There are no (further) constraints on this element Element idQuestionnaire.status active DefinitionThe status of this questionnaire. The status will always be active. Allows filtering of questionnaires that are appropriate for use versus not. The lifecycle status of an artifact.
active
|
experimental | Σ | 0..0 | boolean | There are no (further) constraints on this element Element idQuestionnaire.experimental 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 to be used 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.
|
subjectType | Σ | 0..0 | codeBinding | There are no (further) constraints on this element Element idQuestionnaire.subjectType Resource that can be subject of QuestionnaireResponse DefinitionThe types of subjects that can be the subject of responses created for the questionnaire. 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.date Date last changed Alternate namesRevision Date DefinitionThe date (and optionally time) when the questionnaire was published. 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. 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.
|
publisher | Σ | 0..0 | string | There are no (further) constraints on this element Element idQuestionnaire.publisher Name of the publisher (organization or individual) DefinitionThe name of the organization or individual that published 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.contact 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.
|
description | 0..1 | markdown | There are no (further) constraints on this element Element idQuestionnaire.description Natural language description of the questionnaire DefinitionHelp text is used to describe what questionnaire is used for. This description can be used to capture details such as why the questionnaire was built, 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 | Σ | 2..2 | UsageContext | Element idQuestionnaire.useContext The context that the content is intended to support DefinitionThe use context is both used for definition of who will use the questionnaire, and in what context the questionnaire will be used. This means that the useContext element will support both questionnaires for patient and healthcare professionals, and the context in which the questionnaire is used (for example "Doctor visit" or "Pre-operation questionnaire). Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Unordered, Closed, by code(Value) Constraints
|
PatientQuestionnaire | Σ | 0..1 | UsageContext | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire The context that the content is intended to support DefinitionThe PatientQuestionnaire slice is used when a patient is the intended user for the questionnaire. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.extension 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 manageable, 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
|
code | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.code Type of context being specified DefinitionA code that identifies the type of context being specified by this usage context. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. A code that specifies a type of context being specified by a usage context.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.code.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.code.extension 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 manageable, 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 | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.code.system 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 reference to some definition that establishes the system clearly and unambiguously.
http://terminology.hl7.org/CodeSystem/usage-context-type
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.code.version 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 | Σ | 1..1 | codeFixed Value | Element idQuestionnaire.useContext:PatientQuestionnaire.code.code Symbol in syntax defined by the system DefinitionThe code is a Snomed code for "Patient", and is used for retrieving Questionnaire for patient generated data, i.e. patient forms. Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
user
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.code.display 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.code.userSelected 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.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x] Value that defines the context DefinitionA value that defines the context specified in this context of use. The interpretation of the value is defined by the code. A code that defines the specific value for the context being specified.
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].extension 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 manageable, 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
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding.extension 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 manageable, 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 | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding.system 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 reference to some definition that establishes the system clearly and unambiguously.
http://snomed.info/sct
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding.version 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 | Σ | 1..1 | codeFixed Value | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding.code 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. Note that FHIR strings SHALL NOT exceed 1MB in size
116154003
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding.display 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].coding.userSelected 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PatientQuestionnaire.value[x].text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
PractitionerQuestionnaire | Σ | 0..1 | UsageContext | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire The context that the content is intended to support DefinitionThe PractitionerQuestionnaire slice is used when a healthcare professional is the intended user for the questionnaire. Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.extension 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 manageable, 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
|
code | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.code Type of context being specified DefinitionA code that identifies the type of context being specified by this usage context. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. A code that specifies a type of context being specified by a usage context.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.code.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.code.extension 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 manageable, 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 | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.code.system 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 reference to some definition that establishes the system clearly and unambiguously.
http://terminology.hl7.org/CodeSystem/usage-context-type
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.code.version 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 | Σ | 1..1 | codeFixed Value | Element idQuestionnaire.useContext:PractitionerQuestionnaire.code.code Symbol in syntax defined by the system DefinitionSnomed CT code for "Healthcare professional". Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
user
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.code.display 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.code.userSelected 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.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x] Value that defines the context DefinitionA value that defines the context specified in this context of use. The interpretation of the value is defined by the code. A code that defines the specific value for the context being specified.
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].extension 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 manageable, 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
|
coding | Σ | 0..* | Coding | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for alternative encodings within a code system, and translations to other code systems. Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding.extension 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 manageable, 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 | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding.system 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 reference to some definition that establishes the system clearly and unambiguously.
http://snomed.info/sct
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding.version 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 | Σ | 1..1 | codeFixed Value | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding.code Symbol in syntax defined by the system DefinitionSnomed CT code for "Healthcare professional". Need to refer to a particular code in the system. Note that FHIR strings SHALL NOT exceed 1MB in size
223366009
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding.display 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].coding.userSelected 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.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:PractitionerQuestionnaire.value[x].text Plain text representation of the concept DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Very often the text is the same as a displayName of one of the codings.
|
QuestionnaireContext | Σ | 1..1 | UsageContext | There are no (further) constraints on this element Element idQuestionnaire.useContext:QuestionnaireContext The context that the content is intended to support DefinitionThe QuestionnaireContext slice is used to define the context which the questionnaire is intended for. For example "Doctors visit" or "Pre-operation questionnaire". Assist in searching for appropriate content. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.useContext:QuestionnaireContext.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.useContext:QuestionnaireContext.extension 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 manageable, 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
|
code | Σ | 1..1 | CodingBinding | There are no (further) constraints on this element Element idQuestionnaire.useContext:QuestionnaireContext.code Type of context being specified DefinitionA code that identifies the type of context being specified by this usage context. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. A code that specifies a type of context being specified by a usage context.
|
value[x] | Σ | 1..1 | There are no (further) constraints on this element Element idQuestionnaire.useContext:QuestionnaireContext.value[x] Value that defines the context DefinitionA value that defines the context specified in this context of use. The interpretation of the value is defined by the code. A code that defines the specific value for the context being specified.
| |
valueCodeableConcept | CodeableConcept | There are no (further) constraints on this element Data type | ||
jurisdiction | Σ | 0..0 | CodeableConceptBinding | There are no (further) constraints on this element Element idQuestionnaire.jurisdiction 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. Countries and regions within which this artifact is targeted for use.
|
purpose | 0..0 | markdown | There are no (further) constraints on this element Element idQuestionnaire.purpose 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.copyright 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 must be able to determine any legal restrictions on the use of the questionnaire and/or its content. Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/
| |
approvalDate | 0..0 | date | There are no (further) constraints on this element Element idQuestionnaire.approvalDate 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.
| |
lastReviewDate | 0..0 | date | There are no (further) constraints on this element Element idQuestionnaire.lastReviewDate When the questionnaire was last reviewed 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.
| |
effectivePeriod | Σ I | 0..0 | Period | There are no (further) constraints on this element Element idQuestionnaire.effectivePeriod 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 measure intended to be used for the year 2016 might be published in 2015.
|
code | Σ | 1..* | Coding | There are no (further) constraints on this element Element idQuestionnaire.code Concept that represents the overall questionnaire DefinitionIt is possible to bind codes on questionnaire level with internal codes, or a standard such as Snomed CT. Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code. Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Codes for questionnaires, groups and individual questions.
|
id | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.id 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.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idQuestionnaire.code.extension 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 manageable, 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 | uri | There are no (further) constraints on this element Element idQuestionnaire.code.system 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 reference to some definition that establishes the system clearly and unambiguously.
|
version | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.version 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 | Σ | 1..1 | code | There are no (further) constraints on this element Element idQuestionnaire.code.code 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
display | Σ | 0..1 | string | There are no (further) constraints on this element Element idQuestionnaire.code.display 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idQuestionnaire.code.userSelected 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 | I | 0..0 | BackboneElement | There are no (further) constraints on this element Element idQuestionnaire.item 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.
|
Versions
COS version | Profile version | Required COSMIC version | Date | Description |
---|---|---|---|---|
2.4.0 | 1.0.0 | R8.3.04 | Feb 2022 | Initial version, support for GET. |
Supported Operations
HTTP Methods
Method | Description |
---|---|
GET | GET Questionnaires by given codes. |
Query Operations
Search Parameters
Parameter | Format | Comment |
---|---|---|
code | token | Codes given in Questionnaire.code |
useContext | token | Codes given in Questionnaire.useContext.PatientQuestionnaire |
Supported Queries
GET [baseURL]/Questionnaire/?search?code=
(Search)GET [baseURL]/Questionnaire/_search?code=http://snomed.info/sct|259008006&context=http://snomed.info/sct|116154003
(Search)
Supported SearchInclude Operations
N/A
Supported RevInclude Operations
N/A
Error Codes
In the table below, a few error messages specific for Questionnaire are listed.
Code | Description | Comment |
---|---|---|
400 | Codes should be valid Tokens with system and value | |
400 | Unsupported Context is provided for context parameter | |
404 | Questionnaire not found for the codes |