FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 4.0.1. For a full list of available versions, see the Directory of published versions

Binary-questionnaire.xml

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Not linked to any defined compartments

Raw XML (canonical form)

Generated Questionnaire for Binary

<?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="2019-10-24T11:53:00+11:00"/>
  <publisher value="Health Level Seven International (FHIR Infrastructure)"/>
  <item>
    <linkId value="Binary"/>
    <text value="Pure binary content defined by a format other than FHIR"/>
    <type value="group"/>
    <required value="false"/>
    <repeats value="true"/>
    <item>
      <text value="Typically, Binary resources are used for handling content such as:  * CDA Documents (i.e. with XDS) * PDF Documents * Images (the Media resource is preferred for handling images, but not possible when the content is already binary - e.g. XDS)."/>
      <type value="display"/>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
        <valueCodeableConcept>
          <coding>
            <system value="http://hl7.org/fhir/questionnaire-item-control"/>
            <code value="flyover"/>
            <display value="Fly-over"/>
          </coding>
        </valueCodeableConcept>
      </extension>
      <text value="A binary resource can contain any content, whether text, image, pdf, zip archive, etc."/>
      <type value="display"/>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
        <valueString value="string"/>
      </extension>
      <linkId value="Binary.id"/>
      <type value="group"/>
      <required value="false"/>
      <repeats value="true"/>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
          <valueCodeableConcept>
            <coding>
              <system value="http://hl7.org/fhir/questionnaire-item-control"/>
              <code value="flyover"/>
              <display value="Fly-over"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text value="The 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."/>
        <type value="display"/>
      </item>
      <item>
        <linkId value="Binary.id.value"/>
        <text value="Logical id of this artifact"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </item>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
        <valueInteger value="1"/>
      </extension>
      <linkId value="Binary.meta"/>
      <text value="Metadata about the resource"/>
      <type value="group"/>
      <required value="false"/>
      <repeats value="true"/>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
          <valueCodeableConcept>
            <coding>
              <system value="http://hl7.org/fhir/questionnaire-item-control"/>
              <code value="flyover"/>
              <display value="Fly-over"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text 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."/>
        <type value="display"/>
      </item>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
        <valueString value="uri"/>
      </extension>
      <linkId value="Binary.implicitRules"/>
      <type value="group"/>
      <required value="false"/>
      <repeats value="true"/>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
          <valueCodeableConcept>
            <coding>
              <system value="http://hl7.org/fhir/questionnaire-item-control"/>
              <code value="flyover"/>
              <display value="Fly-over"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text 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. &#xA;&#xA;This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it&#39;s meaning or interpretation."/>
        <type value="display"/>
      </item>
      <item>
        <linkId value="Binary.implicitRules.value"/>
        <text value="A set of rules under which this content was created"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </item>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
        <valueString value="code"/>
      </extension>
      <linkId value="Binary.language"/>
      <type value="group"/>
      <required value="false"/>
      <repeats value="true"/>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
          <valueCodeableConcept>
            <coding>
              <system value="http://hl7.org/fhir/questionnaire-item-control"/>
              <code value="flyover"/>
              <display value="Fly-over"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text 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)."/>
        <type value="display"/>
      </item>
      <item>
        <linkId value="Binary.language.value"/>
        <text value="language"/>
        <type value="choice"/>
        <required value="false"/>
        <repeats value="false"/>
      </item>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
        <valueString value="code"/>
      </extension>
      <linkId value="Binary.contentType"/>
      <type value="group"/>
      <required value="true"/>
      <repeats value="true"/>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
          <valueCodeableConcept>
            <coding>
              <system value="http://hl7.org/fhir/questionnaire-item-control"/>
              <code value="flyover"/>
              <display value="Fly-over"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text value="MimeType of the binary content represented as a standard MimeType (BCP 13)."/>
        <type value="display"/>
      </item>
      <item>
        <linkId value="Binary.contentType.value"/>
        <text value="content type"/>
        <type value="choice"/>
        <required value="false"/>
        <repeats value="false"/>
      </item>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
        <valueString value="Reference"/>
      </extension>
      <linkId value="Binary.securityContext"/>
      <type value="group"/>
      <required value="false"/>
      <repeats value="true"/>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
          <valueCodeableConcept>
            <coding>
              <system value="http://hl7.org/fhir/questionnaire-item-control"/>
              <code value="flyover"/>
              <display value="Fly-over"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text value="Treat this binary as if it was this other resource for access control purposes."/>
        <type value="display"/>
      </item>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource">
          <valueCode value="Resource"/>
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter">
          <valueString value="subject=$subj&amp;patient=$subj&amp;encounter=$encounter"/>
        </extension>
        <linkId value="Binary.securityContext.value"/>
        <text value="Access Control Management"/>
        <type value="reference"/>
        <required value="false"/>
        <repeats value="false"/>
      </item>
    </item>
    <item>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs">
        <valueInteger value="1"/>
      </extension>
      <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-fhirType">
        <valueString value="binary"/>
      </extension>
      <linkId value="Binary.content"/>
      <text value="The actual content"/>
      <type value="group"/>
      <required value="true"/>
      <repeats value="true"/>
      <item>
        <extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl">
          <valueCodeableConcept>
            <coding>
              <system value="http://hl7.org/fhir/questionnaire-item-control"/>
              <code value="flyover"/>
              <display value="Fly-over"/>
            </coding>
          </valueCodeableConcept>
        </extension>
        <text value="The actual content, base64 encoded. If the content type is itself base64 encoding, then this will be base64 encoded twice - what is created by un-base64ing the content must be the specified content type."/>
        <type value="display"/>
      </item>
    </item>
  </item>
</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.