This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Definitions for the cqif-knowledgeresponse Profile.
Basic(CQIF-KnowledgeResponse) | |
Definition | A knowledge response is the formal response to a previous knowledge request, describing the result of the evaluation of the requested artifact or artifacts. This information is used as part of the knowledgeEvaluation operation definition. |
Control | 0..* |
Type | Basic |
Alternate Names | Z-resource, Extension-resource, Custom-resource |
Basic.id | |
Definition | The server-generated id for the response. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
Basic.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Basic.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | 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 as much as possible. |
Basic.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Comments | 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). |
Basic.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Basic.contained | |
Definition | These 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | 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. |
Basic.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | 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. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-requestId) | |
Definition | The id of the request associated with this response. If an id was provided as part of the request, it will be provided here to enable the requester to more easily identify the response in a multi-request scenario. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
Basic.extension (http://hl7.org/fhir/StructureDefinition/cqif-basic-evaluationMessage) | |
Definition | Messages resulting from the evaluation of the artifact or artifacts. As part of evaluating the request, the engine may produce informational or warning messages. These messages will be provided by this element. |
Control | 0..* |
Type | Extension (Extension Type: Reference(OperationOutcome)) |
Basic.modifierExtension | |
Definition | May 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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | 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. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Basic.modifierExtension (http://hl7.org/fhir/StructureDefinition/cqif-basic-module) | |
Definition | A reference to a knowledge module involved in an interaction. |
Control | 0..* |
Type | Extension (Extension Type: Reference(CQIF-KnowledgeModule)) |
Is Modifier | true |
Basic.modifierExtension (http://hl7.org/fhir/StructureDefinition/cqif-basic-responseStatus) | |
Definition | The status of the response. If the evaluation is completed successfully, the status will indicate success. However, in order to complete the evaluation, the engine may require more information. In this case, the status will be data-required, and the response will contain a description of the additional required information. If the evaluation completed successfully, but the engine determines that a potentially more accurate response could be provided if more data was available, the status will be data-requested, and the response will contain a description of the additional requested information. |
Control | 1..1 |
Type | Extension (Extension Type: code) |
Is Modifier | true |
Basic.identifier | |
Definition | Identifier assigned to the resource for business purposes, outside the context of FHIR. |
Control | 0..* |
Type | Identifier |
Basic.code | |
Definition | Identifies the 'type' of resource - equivalent to the resource name for other resources. |
Control | 1..1 |
Binding | The code for knowledge responses The codes SHALL be taken from KnowledgeResponseCode |
Type | CodeableConcept |
Is Modifier | true |
Requirements | Must be able to distinguish different types of "basic" resources. |
Comments | Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. |
Basic.subject | |
Definition | Identifies the patient, practitioner, device or any other resource that is the "focus" of this resoruce. |
Control | 0..1 |
Type | Reference(Resource) |
Requirements | Needed for partitioning the resource by Patient. |
Comments | Optional as not all resources potential resources will have subjects. Resources associated with multiple subjects can handle this via extension. |
Basic.author | |
Definition | Indicates who was responsible for creating the resource instance. |
Control | 0..1 |
Type | Choice of: Reference(Practitioner), Reference(Patient), Reference(RelatedPerson) |
Requirements | Needed for partitioning the resource. |
Basic.created | |
Definition | Identifies when the resource was first created. |
Control | 0..1 |
Type | date |
Requirements | Allows ordering resource instances by time. |