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
The status of the response
{ "resourceType": "StructureDefinition", "id": "cqif-basic-responseStatus", "url": "http://hl7.org/fhir/StructureDefinition/cqif-basic-responseStatus", "name": "The status of the response", "display": "responseStatus", "status": "draft", "publisher": "Health Level Seven, Inc. - CDS WG", "contact": [ { "telecom": [ { "system": "other", "value": "http://hl7.org/special/committees/dss" } ] } ], "date": "2015-05-30", "description": "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.", "kind": "datatype", "constrainedType": "Extension", "abstract": false, "contextType": "resource", "context": [ "Basic" ], "base": "http://hl7.org/fhir/StructureDefinition/Extension", "snapshot": { "element": [ { "path": "Extension", "short": "The status of the response", "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.", "min": 1, "max": "1", "base": { "path": "Extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true }, { "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Extension.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "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 should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/cqif-basic-responseStatus", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.valueCode", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The status of a knowledge response", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/cqif-knowledge-response-status" } }, "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "path": "Extension", "short": "The status of the response", "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.", "min": 1, "max": "1", "type": [ { "code": "Extension" } ], "isModifier": true }, { "path": "Extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.url", "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/cqif-basic-responseStatus" }, { "path": "Extension.value[x]", "min": 1, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The status of a knowledge response", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/cqif-knowledge-response-status" } } } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.