2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extensiondefinition.questionnaire.json

Raw JSON (canonical form)

Generated Questionnaire for ExtensionDefinition

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

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.