2nd DSTU Draft For Comment

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

Extensiondefinition.questionnaire.xml

Raw XML (canonical form)

Generated Questionnaire for ExtensionDefinition

<?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="Defines an extension that can be used in resources."/>
    </extension>
    <linkId value="ExtensionDefinition"/>
    <title value="Extension Definition"/>
    <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="ExtensionDefinition.id"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.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="ExtensionDefinition.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="ExtensionDefinition.implicitRules"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.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="ExtensionDefinition.language"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.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 &quot;clinically safe&quot; 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="ExtensionDefinition.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="ExtensionDefinition.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="The URL at which this definition is (or will be) published, and which is used to reference this profile in extension urls in operational FHIR systems."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="uri"/>
      </extension>
      <linkId value="ExtensionDefinition.url"/>
      <required value="true"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.url.value"/>
        <text value="Literal URL used to reference this extension"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="Formal identifier that is used to identify this profile when it is represented in other formats (e.g. ISO 11179(, or referenced in a specification, model, design or an instance  (should be globally unique OID, UUID, or URI), (if it&#39;s not possible to use the literal URI)."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="Identifier"/>
      </extension>
      <linkId value="ExtensionDefinition.identifier"/>
      <text value="Other identifiers for the extension"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.identifier.label"/>
        <text value="label:"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
      <question>
        <linkId value="ExtensionDefinition.identifier.system"/>
        <text value="system:"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
      <question>
        <linkId value="ExtensionDefinition.identifier.value"/>
        <text value="value:"/>
        <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 identifier that is used to identify this version of the extension definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the author manually. N/A."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="string"/>
      </extension>
      <linkId value="ExtensionDefinition.version"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.version.value"/>
        <text value="Logical id for this version of the extension"/>
        <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 free text natural language name identifying the extension. Not expected to be globally unique."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="string"/>
      </extension>
      <linkId value="ExtensionDefinition.name"/>
      <required value="true"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.name.value"/>
        <text value="Descriptional name for this profile"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="Defined so that applications can use this name when displaying the value of the extension to the user. Applications don&#39;t have to use this name, but can always fall back to it. In the absence of a value for this element, use the name."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="string"/>
      </extension>
      <linkId value="ExtensionDefinition.display"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.display.value"/>
        <text value="Use this name when displaying the value"/>
        <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 name of the individual or organization that published the extension definition. Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="string"/>
      </extension>
      <linkId value="ExtensionDefinition.publisher"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.publisher.value"/>
        <text value="Name of the publisher (Organization or individual)"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="Contacts to assist a user in finding and communicating with the publisher."/>
      </extension>
      <linkId value="ExtensionDefinition.contact"/>
      <title value="Contact details of the publisher"/>
      <text value="May be a web site, an email address, a telephone number (tel:), etc."/>
      <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="ExtensionDefinition.contact.id"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.contact.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 name of an individual to contact regarding the extension definition. If there is no named individual, the telecom is for the organization as a whole."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="string"/>
        </extension>
        <linkId value="ExtensionDefinition.contact.name"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.contact.name.value"/>
          <text value="Name of a individual to contact"/>
          <type value="string"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Contact details for individual (if a name was provided) or the publisher."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="ContactPoint"/>
        </extension>
        <linkId value="ExtensionDefinition.contact.telecom"/>
        <text value="Contact details for individual or publisher"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.contact.telecom.system"/>
          <text value="type:"/>
          <type value="choice"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
        <question>
          <linkId value="ExtensionDefinition.contact.telecom.value"/>
          <text value="value:"/>
          <type value="string"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
        <question>
          <linkId value="ExtensionDefinition.contact.telecom.use"/>
          <text value="use:"/>
          <type value="choice"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="A free text natural language description of the extension and its use. This field can be used for things such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc.  It is *not* a rendering of the extension definition as conveyed in Profile.text."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="string"/>
      </extension>
      <linkId value="ExtensionDefinition.description"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.description.value"/>
        <text value="Natural language description of the extension"/>
        <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 set of terms from external terminologies that may be used to assist with indexing and searching of extension definitions."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="Coding"/>
      </extension>
      <linkId value="ExtensionDefinition.code"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.code.value"/>
        <text value="Assist with indexing and finding"/>
        <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="The status of the extension."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="code"/>
      </extension>
      <linkId value="ExtensionDefinition.status"/>
      <required value="true"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.status.value"/>
        <text value="status"/>
        <type value="choice"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="This extension definition was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="boolean"/>
      </extension>
      <linkId value="ExtensionDefinition.experimental"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.experimental.value"/>
        <text value="If for testing purposes, not real usage"/>
        <type value="boolean"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="The date that this version of the extension was published."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="datetime"/>
      </extension>
      <linkId value="ExtensionDefinition.date"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.date.value"/>
        <text value="Date for this version of the extension"/>
        <type value="dateTime"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="The Scope and Usage that this extension was created to meet."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="string"/>
      </extension>
      <linkId value="ExtensionDefinition.requirements"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.requirements.value"/>
        <text value="Scope and Usage this extesion is for"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="An external specification that the content is mapped to."/>
      </extension>
      <linkId value="ExtensionDefinition.mapping"/>
      <title value="External specification that the content is mapped to"/>
      <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="ExtensionDefinition.mapping.id"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.mapping.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="An Internal id that is used to identify this mapping set when specific mappings are made. The specification is described once, with general comments, and then specific mappings are made that reference this declaration in the element definition."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="string"/>
        </extension>
        <linkId value="ExtensionDefinition.mapping.identity"/>
        <required value="true"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.mapping.identity.value"/>
          <text value="Internal id when this mapping is used"/>
          <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 URI that identifies the specification that this mapping is expressed to. A formal identity for the specification being mapped to helps with identifying maps consistently."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="uri"/>
        </extension>
        <linkId value="ExtensionDefinition.mapping.uri"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.mapping.uri.value"/>
          <text value="Identifies what this mapping refers to"/>
          <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 for the specification that is being mapped to."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="string"/>
        </extension>
        <linkId value="ExtensionDefinition.mapping.name"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.mapping.name.value"/>
          <text value="Names what this mapping refers to"/>
          <type value="string"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="string"/>
        </extension>
        <linkId value="ExtensionDefinition.mapping.comments"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ExtensionDefinition.mapping.comments.value"/>
          <text value="Versions, Issues, Scope limitations etc"/>
          <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="Identifies the type of context to which the extension applies."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="code"/>
      </extension>
      <linkId value="ExtensionDefinition.contextType"/>
      <required value="true"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.contextType.value"/>
        <text value="context 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="Identifies the types of resource or data type elements to which the extension can be applied. If the context is an element that can have multiple types, then use (e.g.) value[x] if the extension works on all choice types, or otherwise an enumeration of explicitly named elements if not. Note that a context of &quot;string&quot; doesn&#39;t mean that the extension can be used with one of the string patterns such as &quot;id&quot; etc."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="string"/>
      </extension>
      <linkId value="ExtensionDefinition.context"/>
      <required value="true"/>
      <repeats value="true"/>
      <question>
        <linkId value="ExtensionDefinition.context.value"/>
        <text value="Where the extension can be used in instances"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="Definition of the elements that are defined to be in the extension."/>
      </extension>
      <linkId value="ExtensionDefinition.element"/>
      <text value="Definition of the elements in the extension"/>
      <required value="true"/>
      <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.