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

Medication.questionnaire.json

Raw JSON (canonical form)

Generated Questionnaire for Medication

{
  "resourceType": "Questionnaire",
  "id": "qs1",
  "contained": [
    {
      "resourceType": "ValueSet",
      "id": "vs2",
      "url": "urn:uuid:f02b018e-270c-4309-954f-f52a45161924",
      "name": "Type options for Medication.product.ingredient.item",
      "description": "Type options for Medication.product.ingredient.item",
      "status": "active",
      "expansion": {
        "timestamp": "2015-02-23T09:21:06+11:00",
        "contains": [
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Substance",
            "display": "Substance"
          },
          {
            "system": "http://hl7.org/fhir/resource-types",
            "code": "Medication",
            "display": "Medication"
          }
        ]
      }
    }
  ],
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986"
    }
  ],
  "status": "draft",
  "date": "2015-02-23T09:07:27+11:00",
  "publisher": "HL7 FHIR Project (Pharmacy)",
  "group": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
        "valueString": "Primarily used for identification and definition of Medication, but also covers ingredients and packaging."
      }
    ],
    "linkId": "Medication",
    "title": "Definition of a Medication",
    "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": "Medication.id",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Medication.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": "Medication.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": "Medication.implicitRules",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Medication.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": "Medication.language",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Medication.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": "Medication.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": "Medication.contained",
        "text": "Contained, inline Resources",
        "required": false,
        "repeats": true
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "The common/commercial name of the medication absent information such as strength, form, etc.  E.g. Acetaminophen, Tylenol 3, etc.  The fully coordinated name is communicated as the display of Medication.code."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "string"
          }
        ],
        "linkId": "Medication.name",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Medication.name.value",
            "text": "Common / Commercial name",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "A code (or set of codes) that identify this medication.   Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes. When defining a medication, the code is the \"identifying\" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "CodeableConcept"
          }
        ],
        "linkId": "Medication.code",
        "text": "Codes that identify this medication",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Medication.code.coding",
            "text": "code:",
            "type": "open-choice",
            "required": false,
            "repeats": false
          },
          {
            "linkId": "Medication.code.text",
            "text": "text:",
            "type": "string",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is)."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "boolean"
          }
        ],
        "linkId": "Medication.isBrand",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Medication.isBrand.value",
            "text": "True if a brand",
            "type": "boolean",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Describes the details of the manufacturer."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "Reference"
          }
        ],
        "linkId": "Medication.manufacturer",
        "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": "Medication.manufacturer.value",
            "text": "Manufacturer of the item",
            "type": "reference",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Medications are either a single administrable product or a package that contains one or more products."
          },
          {
            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
            "valueString": "code"
          }
        ],
        "linkId": "Medication.kind",
        "required": false,
        "repeats": true,
        "question": [
          {
            "linkId": "Medication.kind.value",
            "text": "kind",
            "type": "choice",
            "required": false,
            "repeats": false
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Information that only applies to products (not packages)."
          }
        ],
        "linkId": "Medication.product",
        "title": "Administrable medication details",
        "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": "Medication.product.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Medication.product.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": "Describes the form of the item.  Powder; tables; carton."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "CodeableConcept"
              }
            ],
            "linkId": "Medication.product.form",
            "text": "powder | tablets | carton +",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Medication.product.form.coding",
                "text": "code:",
                "type": "open-choice",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Medication.product.form.text",
                "text": "text:",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Identifies a particular constituent of interest in the product."
              }
            ],
            "linkId": "Medication.product.ingredient",
            "title": "Active or inactive ingredient",
            "text": "The ingredients need not be a complete list; usually only active ingredients are listed.",
            "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": "Medication.product.ingredient.id",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.product.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 actual ingredient - either a substance (simple ingredient) or another medication."
                  }
                ],
                "linkId": "Medication.product.ingredient.item",
                "text": "The product contained",
                "required": true,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.product.ingredient.item._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": "Medication.product.ingredient.item._Substance",
                        "question": [
                          {
                            "extension": [
                              {
                                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                                "valueString": "/Substance?subject=$subj&patient=$subj&encounter=$encounter"
                              }
                            ],
                            "linkId": "Medication.product.ingredient.item._Substance.value",
                            "text": "Substance",
                            "type": "reference",
                            "required": false,
                            "repeats": false
                          }
                        ]
                      },
                      {
                        "extension": [
                          {
                            "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                            "valueString": "Reference"
                          }
                        ],
                        "linkId": "Medication.product.ingredient.item._Medication",
                        "question": [
                          {
                            "extension": [
                              {
                                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                                "valueString": "/Medication?subject=$subj&patient=$subj&encounter=$encounter"
                              }
                            ],
                            "linkId": "Medication.product.ingredient.item._Medication.value",
                            "text": "Medication",
                            "type": "reference",
                            "required": false,
                            "repeats": false
                          }
                        ]
                      }
                    ]
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "Specifies how many (or how much) of the items there are in this Medication.  E.g. 250 mg per tablet."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Ratio"
                  }
                ],
                "linkId": "Medication.product.ingredient.amount",
                "text": "How much ingredient in product",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.product.ingredient.amount.numerator",
                    "text": "numerator:",
                    "type": "decimal",
                    "required": false,
                    "repeats": false
                  },
                  {
                    "linkId": "Medication.product.ingredient.amount.denominator",
                    "text": "denominator:",
                    "type": "decimal",
                    "required": false,
                    "repeats": false
                  },
                  {
                    "linkId": "Medication.product.ingredient.amount.units",
                    "text": "units:",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "Information about a group of medication produced or packaged from one production run."
              }
            ],
            "linkId": "Medication.product.batch",
            "title": "Information about a group of medication produced or packaged from one production run.",
            "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": "Medication.product.batch.id",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.product.batch.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 assigned lot number of a batch of the specified product."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "string"
                  }
                ],
                "linkId": "Medication.product.batch.lotNumber",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.product.batch.lotNumber.value",
                    "text": "The assigned lot number of a batch of the specified product.",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "When this specific batch of product will expire."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "datetime"
                  }
                ],
                "linkId": "Medication.product.batch.expirationDate",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.product.batch.expirationDate.value",
                    "text": "When this specific batch of product will expire.",
                    "type": "dateTime",
                    "required": false,
                    "repeats": false
                  }
                ]
              }
            ]
          }
        ]
      },
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
            "valueString": "Information that only applies to packages (not products)."
          }
        ],
        "linkId": "Medication.package",
        "title": "Details about packaged medications",
        "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": "Medication.package.id",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Medication.package.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 kind of container that this package comes as."
              },
              {
                "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                "valueString": "CodeableConcept"
              }
            ],
            "linkId": "Medication.package.container",
            "text": "E.g. box, vial, blister-pack",
            "required": false,
            "repeats": true,
            "question": [
              {
                "linkId": "Medication.package.container.coding",
                "text": "code:",
                "type": "open-choice",
                "required": false,
                "repeats": false
              },
              {
                "linkId": "Medication.package.container.text",
                "text": "text:",
                "type": "string",
                "required": false,
                "repeats": false
              }
            ]
          },
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                "valueString": "A set of components that go to make up the described item."
              }
            ],
            "linkId": "Medication.package.content",
            "title": "What is  in the package?",
            "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": "Medication.package.content.id",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.package.content.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": "Identifies one of the items in the package."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Reference"
                  }
                ],
                "linkId": "Medication.package.content.item",
                "required": true,
                "repeats": true,
                "question": [
                  {
                    "extension": [
                      {
                        "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#reference",
                        "valueString": "/Medication?subject=$subj&patient=$subj&encounter=$encounter"
                      }
                    ],
                    "linkId": "Medication.package.content.item.value",
                    "text": "A product in the package",
                    "type": "reference",
                    "required": false,
                    "repeats": false
                  }
                ]
              },
              {
                "extension": [
                  {
                    "url": "http://hl7.org/fhir/Profile/questionnaire-extensions#flyover",
                    "valueString": "The amount of the product that is in the package."
                  },
                  {
                    "url": "http://www.healthintersections.com.au/fhir/Profile/metadata#type",
                    "valueString": "Quantity"
                  }
                ],
                "linkId": "Medication.package.content.amount",
                "text": "How many are in the package?",
                "required": false,
                "repeats": true,
                "question": [
                  {
                    "linkId": "Medication.package.content.amount.comparator",
                    "text": "comp:",
                    "type": "choice",
                    "required": false,
                    "repeats": false
                  },
                  {
                    "linkId": "Medication.package.content.amount.value",
                    "text": "value:",
                    "type": "decimal",
                    "required": false,
                    "repeats": false
                  },
                  {
                    "linkId": "Medication.package.content.amount.units",
                    "text": "units:",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  },
                  {
                    "linkId": "Medication.package.content.amount.code",
                    "text": "coded units:",
                    "type": "string",
                    "required": false,
                    "repeats": false
                  },
                  {
                    "linkId": "Medication.package.content.amount.system",
                    "text": "units system:",
                    "type": "string",
                    "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.