This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Generated Questionnaire for OperationOutcome
<?xml version="1.0" encoding="UTF-8"?> <Questionnaire xmlns="http://hl7.org/fhir"> <id value="qs1"/> <identifier> <system value="urn:ietf:rfc:3986"/> </identifier> <status value="draft"/> <date value="2015-02-23T09:07:27+11:00"/> <publisher value="HL7 FHIR Project (FHIR Management Group)"/> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="A collection of error, warning or information messages that result from a system action."/> </extension> <linkId value="OperationOutcome"/> <title value="Information about the success/failure of an action"/> <text value="Can result from the failure of a REST call or be part of the response message returned from a request message. If sent with extensions overriding particular issues, might even appear as part of a request message."/> <required value="true"/> <repeats value="false"/> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="The logical id of the resource, as used in the url for the resoure. 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. Bundles always have an id, though it is usually a generated UUID."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="string"/> </extension> <linkId value="OperationOutcome.id"/> <required value="false"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.id.value"/> <text value="Logical id of this artefact"/> <type value="string"/> <required value="false"/> <repeats value="false"/> </question> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="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."/> </extension> <linkId value="OperationOutcome.meta"/> <text value="Metadata about the resource"/> <required value="false"/> <repeats value="true"/> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="uri"/> </extension> <linkId value="OperationOutcome.implicitRules"/> <required value="false"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.implicitRules.value"/> <text value="A set of rules under which this content was created"/> <type value="string"/> <required value="false"/> <repeats value="false"/> </question> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="The 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)."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="code"/> </extension> <linkId value="OperationOutcome.language"/> <required value="false"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.language.value"/> <text value="language"/> <type value="choice"/> <required value="false"/> <repeats value="false"/> </question> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="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. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> </extension> <linkId value="OperationOutcome.text"/> <text value="Text summary of the resource, for human interpretation"/> <required value="false"/> <repeats value="true"/> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="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. 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."/> </extension> <linkId value="OperationOutcome.contained"/> <text value="Contained, inline Resources"/> <required value="false"/> <repeats value="true"/> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="An error, warning or information message that results from a system action."/> </extension> <linkId value="OperationOutcome.issue"/> <title value="A single issue associated with the action"/> <required value="true"/> <repeats value="true"/> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="unique id for the element within a resource (for internal references)."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="string"/> </extension> <linkId value="OperationOutcome.issue.id"/> <required value="false"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.issue.id.value"/> <text value="xml:id (or equivalent in JSON)"/> <type value="string"/> <required value="false"/> <repeats value="false"/> </question> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="Indicates whether the issue indicates a variation from successful processing. This is labeled as "Is Modifier" because applications should not confuse hints and warnings with errors."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="code"/> </extension> <linkId value="OperationOutcome.issue.severity"/> <required value="true"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.issue.severity.value"/> <text value="severity"/> <type value="choice"/> <required value="false"/> <repeats value="false"/> </question> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="A code indicating the type of error, warning or information message. Codes should only be defined at a level of granularity that reasonably allows distinct actions to be taken by the receiving system. If the response behavior of all systems is the same for two codes, the codes might as well be merged. The human-meaningful content of the issue is conveyed in .text."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="Coding"/> </extension> <linkId value="OperationOutcome.issue.type"/> <required value="false"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.issue.type.value"/> <text value="Error or warning code"/> <type value="open-choice"/> <required value="false"/> <repeats value="false"/> </question> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="Additional description of the issue. typically this field is used to provide details human-readable information about the error."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="string"/> </extension> <linkId value="OperationOutcome.issue.details"/> <required value="false"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.issue.details.value"/> <text value="Additional description of the issue"/> <type value="string"/> <required value="false"/> <repeats value="false"/> </question> </group> <group> <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover"> <valueString value="A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised. The root of the XPath is the resource or bundle that generated OperationOutcome. Each XPath SHALL resolve to a single node. The XPath syntax is used whether the referenced instance is expressed in XML or JSON."/> </extension> <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type"> <valueString value="string"/> </extension> <linkId value="OperationOutcome.issue.location"/> <required value="false"/> <repeats value="true"/> <question> <linkId value="OperationOutcome.issue.location.value"/> <text value="XPath of element(s) related to issue"/> <type value="string"/> <required value="false"/> <repeats value="false"/> </question> </group> </group> </group> </Questionnaire>
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.