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.json

Raw JSON (canonical form)

Generated Questionnaire for ImmunizationRecommendation

{
  "resourceType": "Questionnaire",
  "id": "qs1",
  "contained": [
    {
      "resourceType": "ValueSet",
      "id": "vs2",
      "url": "urn:uuid:abbca2fa-4a7a-4ac3-b2f4-a5d7d48b8b79",
      "name": "Type options for ImmunizationRecommendation.recommendation.supportingPatientInformation",
      "description": "Type options for ImmunizationRecommendation.recommendation.supportingPatientInformation",
      "status": "active",
      "expansion": {
        "timestamp": "2015-02-23T09:20:51+11:00",
        "contains": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Observation",
            "display": "Observation"
          },
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "AllergyIntolerance",
            "display": "AllergyIntolerance"
          }
        ]
      }
    }
  ],
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "publisher": "HL7 FHIR Project (Public Health and Emergency Response)",
  "group": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
        "valueString": "A patient's point-of-time immunization status and recommendation with optional supporting justification."
      }
    ],
    "linkId": "ImmunizationRecommendation",
    "title": "Immunization profile",
    "required": true,
    "repeats": false,
    "group": [
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "ImmunizationRecommendation.id",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "ImmunizationRecommendation.id.value",
            "text": "Logical id of this artefact",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          }
        ],
        "linkId": "ImmunizationRecommendation.meta",
        "text": "Metadata about the resource",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "uri"
          }
        ],
        "linkId": "ImmunizationRecommendation.implicitRules",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "ImmunizationRecommendation.implicitRules.value",
            "text": "A set of rules under which this content was created",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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\n\nNot 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)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "ImmunizationRecommendation.language",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "ImmunizationRecommendation.language.value",
            "text": "language",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."
          }
        ],
        "linkId": "ImmunizationRecommendation.text",
        "text": "Text summary of the resource, for human interpretation",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "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."
          }
        ],
        "linkId": "ImmunizationRecommendation.contained",
        "text": "Contained, inline Resources",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A unique identifier assigned to this particular recommendation record."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Identifier"
          }
        ],
        "linkId": "ImmunizationRecommendation.identifier",
        "text": "Business identifier",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "ImmunizationRecommendation.identifier.label",
            "text": "label:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "ImmunizationRecommendation.identifier.system",
            "text": "system:",
            "type": "string",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "ImmunizationRecommendation.identifier.value",
            "text": "value:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The patient for whom the recommendations are for."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Reference"
          }
        ],
        "linkId": "ImmunizationRecommendation.patient",
        "required": true,
        "repeats": true,
        "question": [
          {
            "extension": [
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                "valueString": "/Patient?subject=$subj&patient=$subj&encounter=$encounter"
              }
            ],
            "linkId": "ImmunizationRecommendation.patient.value",
            "text": "Who this profile is for",
            "type": "reference",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Vaccine administration recommendations."
          }
        ],
        "linkId": "ImmunizationRecommendation.recommendation",
        "title": "Vaccine administration recommendations",
        "required": true,
        "repeats": true,
        "group": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "unique id for the element within a resource (for internal references)."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "string"
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "ImmunizationRecommendation.recommendation.id.value",
                "text": "xml:id (or equivalent in JSON)",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "The date the immunization recommendation was created."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "datetime"
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.date",
            "required": true,
            "repeats": true,
            "question": [
              {
                "linkId": "ImmunizationRecommendation.recommendation.date.value",
                "text": "Date recommendation created",
                "type": "dateTime",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Vaccine that pertains to the recommendation."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "CodeableConcept"
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.vaccineType",
            "text": "Vaccine recommendation applies to",
            "required": true,
            "repeats": true,
            "question": [
              {
                "linkId": "ImmunizationRecommendation.recommendation.vaccineType.coding",
                "text": "code:",
                "type": "open-choice",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "ImmunizationRecommendation.recommendation.vaccineType.text",
                "text": "text:",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "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."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "integer"
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.doseNumber",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "ImmunizationRecommendation.recommendation.doseNumber.value",
                "text": "Recommended dose number",
                "type": "integer",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Vaccine administration status."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "CodeableConcept"
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.forecastStatus",
            "text": "Vaccine administration status",
            "required": true,
            "repeats": true,
            "question": [
              {
                "linkId": "ImmunizationRecommendation.recommendation.forecastStatus.coding",
                "text": "code:",
                "type": "open-choice",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "ImmunizationRecommendation.recommendation.forecastStatus.text",
                "text": "text:",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Vaccine date recommendations - e.g. earliest date to administer, latest date to administer, etc."
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.dateCriterion",
            "title": "Dates governing proposed immunization",
            "required": false,
            "repeats": true,
            "group": [
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "unique id for the element within a resource (for internal references)."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.dateCriterion.id",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.dateCriterion.id.value",
                    "text": "xml:id (or equivalent in JSON)",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Date classification of recommendation - e.g. earliest date to give, latest date to give, etc."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "CodeableConcept"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.dateCriterion.code",
                "text": "Type of date",
                "required": true,
                "repeats": true,
                "question": [
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.dateCriterion.code.coding",
                    "text": "code:",
                    "type": "open-choice",
                    "required": false,
                    "repeats": false
                  },
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.dateCriterion.code.text",
                    "text": "text:",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Date recommendation."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "datetime"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.dateCriterion.value",
                "required": true,
                "repeats": true,
                "question": [
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.dateCriterion.value.value",
                    "text": "Recommended date",
                    "type": "dateTime",
                    "required": false,
                    "repeats": false
                  }
                ]
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Contains information about the protocol under which the vaccine was administered."
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.protocol",
            "title": "Protocol used by recommendation",
            "required": false,
            "repeats": false,
            "group": [
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "unique id for the element within a resource (for internal references)."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.protocol.id",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.protocol.id.value",
                    "text": "xml:id (or equivalent in JSON)",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Indicates the nominal position in a series of the next dose.  This is the recommended dose number as per a specified protocol."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "integer"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.protocol.doseSequence",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.protocol.doseSequence.value",
                    "text": "Number of dose within sequence",
                    "type": "integer",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Contains the description about the protocol under which the vaccine was administered."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.protocol.description",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.protocol.description.value",
                    "text": "Protocol details",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Indicates the authority who published the protocol?  E.g. ACIP."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.protocol.authority",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/Organization?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "ImmunizationRecommendation.recommendation.protocol.authority.value",
                    "text": "Who is responsible for protocol",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "One possible path to achieve presumed immunity against a disease - within the context of an authority."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.protocol.series",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "ImmunizationRecommendation.recommendation.protocol.series.value",
                    "text": "Name of vaccination series",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Immunization event history that supports the status and recommendation."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "Reference"
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.supportingImmunization",
            "required": false,
            "repeats": true,
            "question": [
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                    "valueString": "/Immunization?subject=$subj&patient=$subj&encounter=$encounter"
                  }
                ],
                "linkId": "ImmunizationRecommendation.recommendation.supportingImmunization.value",
                "text": "Past immunizations supporting recommendation",
                "type": "reference",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Patient Information that supports the status and recommendation.  This includes patient observations, adverse reactions and allergy/intolerance information."
              }
            ],
            "linkId": "ImmunizationRecommendation.recommendation.supportingPatientInformation",
            "text": "Patient observations supporting recommendation",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "ImmunizationRecommendation.recommendation.supportingPatientInformation._type",
                "text": "type",
                "type": "choice",
                "required": false,
                "repeats": false,
                "options": {
                  "reference": "#vs2"
                },
                "group": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                        "valueString": "Reference"
                      }
                    ],
                    "linkId": "ImmunizationRecommendation.recommendation.supportingPatientInformation._Observation",
                    "question": [
                      {
                        "extension": [
                          {
                            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                            "valueString": "/Observation?subject=$subj&patient=$subj&encounter=$encounter"
                          }
                        ],
                        "linkId": "ImmunizationRecommendation.recommendation.supportingPatientInformation._Observation.value",
                        "text": "Observation",
                        "type": "reference",
                        "required": false,
                        "repeats": false
                      }
                    ]
                  },
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                        "valueString": "Reference"
                      }
                    ],
                    "linkId": "ImmunizationRecommendation.recommendation.supportingPatientInformation._AllergyIntolerance",
                    "question": [
                      {
                        "extension": [
                          {
                            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                            "valueString": "/AllergyIntolerance?subject=$subj&patient=$subj&encounter=$encounter"
                          }
                        ],
                        "linkId": "ImmunizationRecommendation.recommendation.supportingPatientInformation._AllergyIntolerance.value",
                        "text": "AllergyIntolerance",
                        "type": "reference",
                        "required": false,
                        "repeats": false
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

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.