FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/extension-itemOrder

Packagefhir.argonaut.questionnaire
TypeStructureDefinition
Idextension-itemOrder
FHIR VersionR3
Sourcehttp://fhir.org/guides/argonaut/questionnaire/http://fhir.org/guides/argonaut/questionnaire/1.0.0/StructureDefinition-extension-itemOrder.html
URLhttp://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-itemOrder
Version1.0.0
Statusactive
Date2019-02-04T00:00:00+11:00
Nameextension_item_order
TitleArgonaut Questionnaire Item Order Extension
Realmus
Authorityhl7
DescriptionA non-negative integer representing the order of questions within Questionnaires groups, groups within groups and groups within questions and the order of answer choices for questions of type 'choice' and 'open-choice using `Questionnaire.item.option`. The order values should be consecutive and start at 0 or 1.
PurposeThe order of questions within groups, groups within groups and groups within questions is relevant and must be retained for display and capture for both Questionnaire. The order of answer choices may also be significant.
TypeExtension
Kindcomplex-type

Resources that use this resource

StructureDefinition
argo-questionnaireArgonaut Questionnaire Profile

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Questions and answer choice order rank.
... url uri"http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-itemOrder"
... valueInteger integer

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "extension-itemOrder",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-itemOrder",
  "version": "1.0.0",
  "name": "extension_item_order",
  "title": "Argonaut Questionnaire Item Order Extension",
  "status": "active",
  "date": "2019-02-04T00:00:00+11:00",
  "publisher": "The Argonaut Project",
  "description": "A non-negative integer representing the order of questions within Questionnaires groups, groups within groups and groups within questions and the order of answer choices for questions of type 'choice' and 'open-choice using `Questionnaire.item.option`. The order values should be consecutive and start at 0 or 1.",
  "purpose": "The order of questions within groups, groups within groups and groups within questions is relevant and must be retained for display and capture for both Questionnaire.  The order of answer choices may also be significant.",
  "fhirVersion": "3.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "contextType": "resource",
  "context": [
    "Questionnaire.item",
    "Questionnaire.item.option"
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Questions and answer choice order rank.",
        "definition": "A non-negative integer representing the order of questions within Questionnaires groups, groups within groups and groups within questions and the order of answer choices for questions of type 'choice' and 'open-choice using `Questionnaire.item.option`. The order values should be consecutive and start at 0 or 1",
        "comment": "Note that a the order within an array *SHALL* be maintained in conformant FHIR implementation.  However in practice, this can be difficult to validate and maintain. An explicit order element for Questionnaires item groups and answer choices helps the renderer to preserve the proper order.  For example when the resource instance is split up and then reassembled from an application's internal format.      When using a contained value set representing permitted answers for a 'choice' or 'open-choice' question use the standard FHIR extension [valueset-conceptOrder](http://hl7.org/fhir/STU3/extension-valueset-conceptorder.html) to indicate the order rank in the same manner as with this extension",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() | (children().count() > id.count())",
            "xpath": "@value|f:*|h:div",
            "source": "Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
            "source": "Extension"
          }
        ],
        "isModifier": false
      },
      {
        "id": "Extension.id",
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
        "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "representation": [
          "xmlAttr"
        ],
        "short": "identifies the meaning of the extension",
        "definition": "Source of the definition for the extension code - a logical name or a URL.",
        "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-itemOrder",
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.valueInteger",
        "path": "Extension.valueInteger",
        "short": "Value of extension",
        "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "Questions and answer choice order rank.",
        "definition": "A non-negative integer representing the order of questions within Questionnaires groups, groups within groups and groups within questions and the order of answer choices for questions of type 'choice' and 'open-choice using `Questionnaire.item.option`. The order values should be consecutive and start at 0 or 1",
        "comment": "Note that a the order within an array *SHALL* be maintained in conformant FHIR implementation.  However in practice, this can be difficult to validate and maintain. An explicit order element for Questionnaires item groups and answer choices helps the renderer to preserve the proper order.  For example when the resource instance is split up and then reassembled from an application's internal format.      When using a contained value set representing permitted answers for a 'choice' or 'open-choice' question use the standard FHIR extension [valueset-conceptOrder](http://hl7.org/fhir/STU3/extension-valueset-conceptorder.html) to indicate the order rank in the same manner as with this extension",
        "min": 0,
        "max": "1",
        "isModifier": false
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://fhir.org/guides/argonaut/questionnaire/StructureDefinition/extension-itemOrder"
      },
      {
        "id": "Extension.valueInteger",
        "path": "Extension.valueInteger",
        "type": [
          {
            "code": "integer"
          }
        ]
      }
    ]
  }
}