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

Substance.questionnaire.json

Raw JSON (canonical form)

Generated Questionnaire for Substance

{
  "resourceType": "Questionnaire",
  "id": "qs1",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "publisher": "HL7 FHIR Project (Orders and Observations)",
  "group": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
        "valueString": "A homogeneous material with a definite composition."
      }
    ],
    "linkId": "Substance",
    "title": "A homogeneous material with a definite composition",
    "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": "Substance.id",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Substance.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": "Substance.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": "Substance.implicitRules",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Substance.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": "Substance.language",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Substance.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": "Substance.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": "Substance.contained",
        "text": "Contained, inline Resources",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A code (or set of codes) that identify this substance. This could be a reference to an externally defined code.  It could also be a locally assigned code (e.g. a formulary),  optionally with translations to the standard drug codes."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "CodeableConcept"
          }
        ],
        "linkId": "Substance.type",
        "text": "What kind of substance this is",
        "required": true,
        "repeats": true,
        "question": [
          {
            "linkId": "Substance.type.coding",
            "text": "code:",
            "type": "open-choice",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Substance.type.text",
            "text": "text:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A description of the substance - its appearance, handling requirements, and other usage notes."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Substance.description",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Substance.description.value",
            "text": "Textual description of the substance, comments",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance."
          }
        ],
        "linkId": "Substance.instance",
        "title": "If this describes a specific package/container of the substance",
        "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": "Substance.instance.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Substance.instance.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": "Identifier associated with the package/container (usually a label affixed directly)."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "Identifier"
              }
            ],
            "linkId": "Substance.instance.identifier",
            "text": "Identifier of the package/container",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Substance.instance.identifier.label",
                "text": "label:",
                "type": "string",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.instance.identifier.system",
                "text": "system:",
                "type": "string",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.instance.identifier.value",
                "text": "value:",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "datetime"
              }
            ],
            "linkId": "Substance.instance.expiry",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Substance.instance.expiry.value",
                "text": "When no longer valid to use",
                "type": "dateTime",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "The amount of the substance."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "Quantity"
              }
            ],
            "linkId": "Substance.instance.quantity",
            "text": "Amount of substance in the package",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Substance.instance.quantity.comparator",
                "text": "comp:",
                "type": "choice",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.instance.quantity.value",
                "text": "value:",
                "type": "decimal",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.instance.quantity.units",
                "text": "units:",
                "type": "string",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.instance.quantity.code",
                "text": "coded units:",
                "type": "string",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.instance.quantity.system",
                "text": "units system:",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A substance can be composed of other substances."
          }
        ],
        "linkId": "Substance.ingredient",
        "title": "Composition information about the substance",
        "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": "Substance.ingredient.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Substance.ingredient.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 amount of the ingredient in the substance - a concentration ratio."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "Ratio"
              }
            ],
            "linkId": "Substance.ingredient.quantity",
            "text": "Optional amount (concentration)",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Substance.ingredient.quantity.numerator",
                "text": "numerator:",
                "type": "decimal",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.ingredient.quantity.denominator",
                "text": "denominator:",
                "type": "decimal",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Substance.ingredient.quantity.units",
                "text": "units:",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Another substance that is a component of this substance."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "Reference"
              }
            ],
            "linkId": "Substance.ingredient.substance",
            "required": true,
            "repeats": true,
            "question": [
              {
                "extension": [
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                    "valueString": "/Substance?subject=$subj&patient=$subj&encounter=$encounter"
                  }
                ],
                "linkId": "Substance.ingredient.substance.value",
                "text": "A component of the substance",
                "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.