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

Immunizationrecommendation.questionnaire.xml

Raw XML (canonical form)

Generated Questionnaire for ImmunizationRecommendation

<?xml version="1.0" encoding="UTF-8"?>

<Questionnaire xmlns="http://hl7.org/fhir">
  <id value="qs1"/>
  <contained>
    <ValueSet>
      <id value="vs2"/>
      <url value="urn:uuid:abbca2fa-4a7a-4ac3-b2f4-a5d7d48b8b79"/>
      <name value="Type options for ImmunizationRecommendation.recommendation.supportingPatientInformation"/>
      <description value="Type options for ImmunizationRecommendation.recommendation.supportingPatientInformation"/>
      <status value="active"/>
      <expansion>
        <timestamp value="2015-02-23T09:20:51+11:00"/>
        <contains>
          <system value="http://hl7.org/fhir/resource-types"/>
          <code value="Observation"/>
          <display value="Observation"/>
        </contains>
        <contains>
          <system value="http://hl7.org/fhir/resource-types"/>
          <code value="AllergyIntolerance"/>
          <display value="AllergyIntolerance"/>
        </contains>
      </expansion>
    </ValueSet>
  </contained>
  <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 (Public Health and Emergency Response)"/>
  <group>
    <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
      <valueString value="A patient&#39;s point-of-time immunization status and recommendation with optional supporting justification."/>
    </extension>
    <linkId value="ImmunizationRecommendation"/>
    <title value="Immunization profile"/>
    <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="ImmunizationRecommendation.id"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ImmunizationRecommendation.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="ImmunizationRecommendation.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="ImmunizationRecommendation.implicitRules"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ImmunizationRecommendation.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="ImmunizationRecommendation.language"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ImmunizationRecommendation.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="ImmunizationRecommendation.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="ImmunizationRecommendation.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="A unique identifier assigned to this particular recommendation record."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="Identifier"/>
      </extension>
      <linkId value="ImmunizationRecommendation.identifier"/>
      <text value="Business identifier"/>
      <required value="false"/>
      <repeats value="true"/>
      <question>
        <linkId value="ImmunizationRecommendation.identifier.label"/>
        <text value="label:"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
      <question>
        <linkId value="ImmunizationRecommendation.identifier.system"/>
        <text value="system:"/>
        <type value="string"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
      <question>
        <linkId value="ImmunizationRecommendation.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 patient for whom the recommendations are for."/>
      </extension>
      <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
        <valueString value="Reference"/>
      </extension>
      <linkId value="ImmunizationRecommendation.patient"/>
      <required value="true"/>
      <repeats value="true"/>
      <question>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#reference">
          <valueString value="/Patient?subject=$subj&amp;patient=$subj&amp;encounter=$encounter"/>
        </extension>
        <linkId value="ImmunizationRecommendation.patient.value"/>
        <text value="Who this profile is for"/>
        <type value="reference"/>
        <required value="false"/>
        <repeats value="false"/>
      </question>
    </group>
    <group>
      <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
        <valueString value="Vaccine administration recommendations."/>
      </extension>
      <linkId value="ImmunizationRecommendation.recommendation"/>
      <title value="Vaccine administration recommendations"/>
      <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="ImmunizationRecommendation.recommendation.id"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.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 date the immunization recommendation was created."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="datetime"/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.date"/>
        <required value="true"/>
        <repeats value="true"/>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.date.value"/>
          <text value="Date recommendation created"/>
          <type value="dateTime"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Vaccine that pertains to the recommendation."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="CodeableConcept"/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.vaccineType"/>
        <text value="Vaccine recommendation applies to"/>
        <required value="true"/>
        <repeats value="true"/>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.vaccineType.coding"/>
          <text value="code:"/>
          <type value="open-choice"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.vaccineType.text"/>
          <text value="text:"/>
          <type value="string"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="This indicates the next recommended dose number (e.g. dose 2 is the next recommended dose). May need other dose concepts such as administered vs. valid."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="integer"/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.doseNumber"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.doseNumber.value"/>
          <text value="Recommended dose number"/>
          <type value="integer"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Vaccine administration status."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="CodeableConcept"/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.forecastStatus"/>
        <text value="Vaccine administration status"/>
        <required value="true"/>
        <repeats value="true"/>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.forecastStatus.coding"/>
          <text value="code:"/>
          <type value="open-choice"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.forecastStatus.text"/>
          <text value="text:"/>
          <type value="string"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc."/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.dateCriterion"/>
        <title value="Dates governing proposed immunization"/>
        <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="ImmunizationRecommendation.recommendation.dateCriterion.id"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.dateCriterion.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="Date classification of recommendation - e.g. earliest date to give, latest date to give, etc."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="CodeableConcept"/>
          </extension>
          <linkId value="ImmunizationRecommendation.recommendation.dateCriterion.code"/>
          <text value="Type of date"/>
          <required value="true"/>
          <repeats value="true"/>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.dateCriterion.code.coding"/>
            <text value="code:"/>
            <type value="open-choice"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.dateCriterion.code.text"/>
            <text value="text:"/>
            <type value="string"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="Date recommendation."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="datetime"/>
          </extension>
          <linkId value="ImmunizationRecommendation.recommendation.dateCriterion.value"/>
          <required value="true"/>
          <repeats value="true"/>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.dateCriterion.value.value"/>
            <text value="Recommended date"/>
            <type value="dateTime"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Contains information about the protocol under which the vaccine was administered."/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.protocol"/>
        <title value="Protocol used by recommendation"/>
        <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="ImmunizationRecommendation.recommendation.protocol.id"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.protocol.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 the nominal position in a series of the next dose.  This is the recommended dose number as per a specified protocol."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="integer"/>
          </extension>
          <linkId value="ImmunizationRecommendation.recommendation.protocol.doseSequence"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.protocol.doseSequence.value"/>
            <text value="Number of dose within sequence"/>
            <type value="integer"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="Contains the description about the protocol under which the vaccine was administered."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="string"/>
          </extension>
          <linkId value="ImmunizationRecommendation.recommendation.protocol.description"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.protocol.description.value"/>
            <text value="Protocol details"/>
            <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 the authority who published the protocol?  E.g. ACIP."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="Reference"/>
          </extension>
          <linkId value="ImmunizationRecommendation.recommendation.protocol.authority"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#reference">
              <valueString value="/Organization?subject=$subj&amp;patient=$subj&amp;encounter=$encounter"/>
            </extension>
            <linkId value="ImmunizationRecommendation.recommendation.protocol.authority.value"/>
            <text value="Who is responsible for protocol"/>
            <type value="reference"/>
            <required value="false"/>
            <repeats value="false"/>
          </question>
        </group>
        <group>
          <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
            <valueString value="One possible path to achieve presumed immunity against a disease - within the context of an authority."/>
          </extension>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
            <valueString value="string"/>
          </extension>
          <linkId value="ImmunizationRecommendation.recommendation.protocol.series"/>
          <required value="false"/>
          <repeats value="true"/>
          <question>
            <linkId value="ImmunizationRecommendation.recommendation.protocol.series.value"/>
            <text value="Name of vaccination series"/>
            <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="Immunization event history that supports the status and recommendation."/>
        </extension>
        <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
          <valueString value="Reference"/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.supportingImmunization"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#reference">
            <valueString value="/Immunization?subject=$subj&amp;patient=$subj&amp;encounter=$encounter"/>
          </extension>
          <linkId value="ImmunizationRecommendation.recommendation.supportingImmunization.value"/>
          <text value="Past immunizations supporting recommendation"/>
          <type value="reference"/>
          <required value="false"/>
          <repeats value="false"/>
        </question>
      </group>
      <group>
        <extension url="http://hl7.org/fhir/Profile/questionnaire-extensions#flyover">
          <valueString value="Patient Information that supports the status and recommendation.  This includes patient observations, adverse reactions and allergy/intolerance information."/>
        </extension>
        <linkId value="ImmunizationRecommendation.recommendation.supportingPatientInformation"/>
        <text value="Patient observations supporting recommendation"/>
        <required value="false"/>
        <repeats value="true"/>
        <question>
          <linkId value="ImmunizationRecommendation.recommendation.supportingPatientInformation._type"/>
          <text value="type"/>
          <type value="choice"/>
          <required value="false"/>
          <repeats value="false"/>
          <options>
            <reference value="#vs2"/>
          </options>
          <group>
            <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
              <valueString value="Reference"/>
            </extension>
            <linkId value="ImmunizationRecommendation.recommendation.supportingPatientInformation._Observation"/>
            <question>
              <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#reference">
                <valueString value="/Observation?subject=$subj&amp;patient=$subj&amp;encounter=$encounter"/>
              </extension>
              <linkId value="ImmunizationRecommendation.recommendation.supportingPatientInformation._Observation.value"/>
              <text value="Observation"/>
              <type value="reference"/>
              <required value="false"/>
              <repeats value="false"/>
            </question>
          </group>
          <group>
            <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#type">
              <valueString value="Reference"/>
            </extension>
            <linkId value="ImmunizationRecommendation.recommendation.supportingPatientInformation._AllergyIntolerance"/>
            <question>
              <extension url="http://www.healthintersections.com.au/fhir/Profile/metadata#reference">
                <valueString value="/AllergyIntolerance?subject=$subj&amp;patient=$subj&amp;encounter=$encounter"/>
              </extension>
              <linkId value="ImmunizationRecommendation.recommendation.supportingPatientInformation._AllergyIntolerance.value"/>
              <text value="AllergyIntolerance"/>
              <type value="reference"/>
              <required value="false"/>
              <repeats value="false"/>
            </question>
          </group>
        </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.