This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Bundle.questionnaire.xml

Raw XML (canonical form)

Generated Questionnaire for Bundle

<?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-03-27T00:13:00+11:00"/>
  <publisher value="HL7 FHIR Project (FHIR Management Group)"/>
  <group>
    <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
      <valueString value="A container for a collection of resources."/>
    </extension>
    <linkId value="Bundle"/>
    <title value="Contains a collection of resources"/>
    <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="Bundle.id"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="Bundle.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="Bundle.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="Bundle.implicitRules"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="Bundle.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="Bundle.language"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="Bundle.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="Indicates the purpose of this bundle- how it was intended to be used. It&#39;s possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="code"/>
      </extension>
      <linkId value="Bundle.type"/>
      <required value="true"/>
      <repeats value="true"/>
      <question>
        <linkId value="Bundle.type.value"/>
        <text value="type"/>
        <type value="choice"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="The base URL for the service that provided these resources. All relative URLs are relative to this one (equivalent to xml:base)."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="uri"/>
      </extension>
      <linkId value="Bundle.base"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="Bundle.base.value"/>
        <text value="Stated Base URL"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="If a set of search matches, this is the total number of matches for the search (as opposed to the number of results in this bundle). Only used if the bundle is a search result set."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="integer"/>
      </extension>
      <linkId value="Bundle.total"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="Bundle.total.value"/>
        <text value="If search, the total number of matches"/>
        <type value="integer"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="A series of links that provide context to this bundle."/>
      </extension>
      <linkId value="Bundle.link"/>
      <title value="Links related to this Bundle"/>
      <required value="false"/>
      <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="Bundle.link.id"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="Bundle.link.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="A name which details the functional use for this link - see [[http://www.iana.org/assignments/link-relations/link-relations.xhtml]]."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="string"/>
        </extension>
        <linkId value="Bundle.link.relation"/>
        <required value="true"/>
        <repeats value="true"/>
        <question>
          <linkId value="Bundle.link.relation.value"/>
          <text value="http://www.iana.org/assignments/link-relations/link-relations.xhtml"/>
          <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 reference details for the link."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="uri"/>
        </extension>
        <linkId value="Bundle.link.url"/>
        <required value="true"/>
        <repeats value="true"/>
        <question>
          <linkId value="Bundle.link.url.value"/>
          <text value="Reference details for the link"/>
          <type value="string"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="An entry in a bundle resource - will either contain a resource, or information about a resource (transactions and history only)."/>
      </extension>
      <linkId value="Bundle.entry"/>
      <title value="Entry in the bundle - will have a resource, or information"/>
      <required value="false"/>
      <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="Bundle.entry.id"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="Bundle.entry.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="The Base URL for the resource, if different to the base URL specified for the bundle as a whole. This allows bundles to be composed of resources from multiple servers (collated search, documents etc)."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="uri"/>
        </extension>
        <linkId value="Bundle.entry.base"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="Bundle.entry.base.value"/>
          <text value="Base URL, if different to bundle base"/>
          <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 series of links that provide context to this entry."/>
        </extension>
        <linkId value="Bundle.entry.link"/>
        <title value="Links related to this entry"/>
        <required value="false"/>
        <repeats value="true"/>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="The Resources for the entry."/>
        </extension>
        <linkId value="Bundle.entry.resource"/>
        <text value="Resources in this bundle"/>
        <required value="false"/>
        <repeats value="true"/>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Information about the search process that lead to the creation of this entry."/>
        </extension>
        <linkId value="Bundle.entry.search"/>
        <title value="Search related information"/>
        <required value="false"/>
        <repeats value="false"/>
        <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="Bundle.entry.search.id"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.search.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="Why this entry is in the result set - whether it&#39;s included as a match or because of an _include requirement."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="code"/>
          </extension>
          <linkId value="Bundle.entry.search.mode"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.search.mode.value"/>
            <text value="mode"/>
            <type value="choice"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="When searching, the server&#39;s search ranking score for the entry. Servers are not required to return a ranking score. 1 is most relevant, and 0 is least relevant. Often, search results are sorted by score, but the client may specify a different sort order."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="decimal"/>
          </extension>
          <linkId value="Bundle.entry.search.score"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.search.score.value"/>
            <text value="Search ranking (between 0 and 1)"/>
            <type value="decimal"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Additional information about how this entry should be processed as part of a transaction."/>
        </extension>
        <linkId value="Bundle.entry.transaction"/>
        <title value="Transaction Related Information"/>
        <required value="false"/>
        <repeats value="false"/>
        <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="Bundle.entry.transaction.id"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transaction.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="The HTTP verb for this entry in either a update history, or a transaction/ transaction response."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="code"/>
          </extension>
          <linkId value="Bundle.entry.transaction.method"/>
          <required value="true"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transaction.method.value"/>
            <text value="method"/>
            <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 search URL for this resource that specifies how the resource is matched to an existing resource when processing a transaction (see transaction documentation)."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="uri"/>
          </extension>
          <linkId value="Bundle.entry.transaction.url"/>
          <required value="true"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transaction.url.value"/>
            <text value="The URL for the transaction"/>
            <type value="string"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="If the ETag values match, return a 304 Not modified status. See the read/vread interaction documentation."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="string"/>
          </extension>
          <linkId value="Bundle.entry.transaction.ifNoneMatch"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transaction.ifNoneMatch.value"/>
            <text value="For managing cache currency"/>
            <type value="string"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="Only perform the operation if the Etag value matches. For more information, see the API section &quot;Managing Resource Contention&quot;."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="string"/>
          </extension>
          <linkId value="Bundle.entry.transaction.ifMatch"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transaction.ifMatch.value"/>
            <text value="For managing update contention"/>
            <type value="string"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="Only perform the operation if the last updated date matches. For more information, see the API section &quot;Managing Resource Contention&quot;."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="instant"/>
          </extension>
          <linkId value="Bundle.entry.transaction.ifModifiedSince"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transaction.ifModifiedSince.value"/>
            <text value="For managing update contention"/>
            <type value="instant"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="Instruct the server not to perform the create if a specified resource already exists. For further information, see &quot;Conditional Create&quot;."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="string"/>
          </extension>
          <linkId value="Bundle.entry.transaction.ifNoneExist"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transaction.ifNoneExist.value"/>
            <text value="For conditional creates"/>
            <type value="string"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Additional information about how this entry should be processed as part of a transaction."/>
        </extension>
        <linkId value="Bundle.entry.transactionResponse"/>
        <title value="Transaction Related Information"/>
        <required value="false"/>
        <repeats value="false"/>
        <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="Bundle.entry.transactionResponse.id"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transactionResponse.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="The status code returned by processing this entry."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="string"/>
          </extension>
          <linkId value="Bundle.entry.transactionResponse.status"/>
          <required value="true"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transactionResponse.status.value"/>
            <text value="Status return code for entry"/>
            <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 location header created by processing this operation."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="uri"/>
          </extension>
          <linkId value="Bundle.entry.transactionResponse.location"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transactionResponse.location.value"/>
            <text value="The location, if the operation returns a location"/>
            <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 etag for the resource, it the operation for the entry produced a versioned resource. This has to match the version id in the header if a resource is included."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="string"/>
          </extension>
          <linkId value="Bundle.entry.transactionResponse.etag"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transactionResponse.etag.value"/>
            <text value="The etag for the resource (if relevant)"/>
            <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 date/time that the resource was modified on the server. This has to match the same time in the meta header if a resource is included."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="instant"/>
          </extension>
          <linkId value="Bundle.entry.transactionResponse.lastModified"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="Bundle.entry.transactionResponse.lastModified.value"/>
            <text value="Server&#39;s date time modified"/>
            <type value="instant"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
      </group>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="XML Digital Signature - base64 encoded. This is base 64 encoded to address issues with json/xml."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="binary"/>
      </extension>
      <linkId value="Bundle.signature"/>
      <text value="XML Digital Signature (base64 encoded)"/>
      <required value="false"/>
      <repeats value="true"/>
    </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.