Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2 R3

Content Detailed Descriptions Mappings XML JSON

Example StructureDefinition/structuredefinition-summary (JSON)

Extension: maxOccurs URL for this extension: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs Status: draft. Extension maintained by: HL7 The maximum number of times the group must appear, or the maximum number of answers for a question - when greater than 1 and not unlimited. Comment : Only relevant if the element has repeats=true and there's a need to constrain the number of allowed repetitions. Context of Use: Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, with Context Invariant = type!='display' and (repeats=true or %extension.valueInteger=1) Extension Content
FHIR Infrastructure Work Group   Maturity Level : 1 N/A Standards Status : Informative Use Context : Any
  • Summary Narrative
    • Full Structure
  • XML
  • JSON
  • All TTL
    • Summary Name Flags Card. Type Description & Constraints maxOccurs 0..1 integer URL = http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs maxOccurs: The maximum number of times the group must appear, or the maximum number of answers for a question - when greater than 1 and not unlimited. Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type!='display' and (repeats=true or %extension.valueInteger=1)</code> Documentation for this format

Full Structure Name Flags Card. Type Description & Constraints extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs maxOccurs: The maximum number of times the group must appear, or the maximum number of answers for a question - when greater than 1 and not unlimited. Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type!='display' and (repeats=true or %extension.valueInteger=1)</code> extension I 0..0 url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" value[x] Raw JSON I 1..1 integer ( canonical form Value of extension Documentation for this format + also see JSON Format Specification XML Template )

<!-- maxOccurs --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension>

JSON Template summary

{ // // from Element: " ] " " 
{
  "resourceType" : "StructureDefinition",
  "id" : "structuredefinition-summary",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "fhir"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 1
  }],
  "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.5.1028"
  }],
  "version" : "5.0.0-ballot",
  "name" : "summary",
  "title" : "summary",
  "status" : "draft",
  "experimental" : false,
  "date" : "2014-01-31",
  "publisher" : "Health Level Seven, Inc. - [WG Name] WG",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/special/committees/FHIR"
    }]
  }],
  "description" : "Additional text for the summary presentation.",
  "fhirVersion" : "5.0.0",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "complex-type",
  "abstract" : false,
  "context" : [{
    "type" : "element",
    "expression" : "StructureDefinition"
  }],
  "type" : "Extension",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation" : "constraint",
  "snapshot" : {
    "element" : [{
      "id" : "Extension",
      "path" : "Extension",
      "short" : "Additional text for the summary presentation",
      "definition" : "Additional text for the summary presentation.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Extension",
        "min" : 0,
        "max" : "*"
      },
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/Extension"
      }],
      "isModifier" : false
    },
    {
      "id" : "Extension.id",
      "path" : "Extension.id",
      "representation" : ["xmlAttr"],
      "short" : "Unique id for inter-element referencing",
      "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" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl" : "id"
        }],
        "code" : "http://hl7.org/fhirpath/System.String"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "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" : "Extension",
      "definition" : "An Extension",
      "min" : 0,
      "max" : "0",
      "base" : {
        "path" : "Element.extension",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Extension"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/Extension"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "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" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl" : "uri"
        }],
        "code" : "http://hl7.org/fhirpath/System.String"
      }],
      "fixedUri" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary",
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "Extension.value[x]",
      "path" : "Extension.value[x]",
      "short" : "Value of extension",
      "definition" : "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "Extension.value[x]",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "markdown"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    }]
  },
  "differential" : {
    "element" : [{
      "id" : "Extension",
      "path" : "Extension",
      "short" : "Additional text for the summary presentation",
      "definition" : "Additional text for the summary presentation.",
      "min" : 0,
      "max" : "1"
    },
    {
      "id" : "Extension.extension",
      "path" : "Extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.url",
      "path" : "Extension.url",
      "fixedUri" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-summary"
    },
    {
      "id" : "Extension.value[x]",
      "path" : "Extension.value[x]",
      "min" : 1,
      "type" : [{
        "code" : "markdown"
      }]
    }]

  }
}

Summary Name Flags Card. Type Description & Constraints maxOccurs 0..1 integer URL = http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs maxOccurs: The maximum number of times the group must appear, or Usage note: every effort has been made to ensure that the maximum number of answers for a question - when greater than 1 examples are correct and useful, but they are not unlimited. Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type!='display' and (repeats=true or %extension.valueInteger=1)</code> Documentation for this format Full Structure Name Flags Card. Type Description & Constraints extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs maxOccurs: The maximum number of times the group must appear, or the maximum number of answers for a question - when greater than 1 and not unlimited. Use on Element ID Questionnaire.item or Element ID Questionnaire.item.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>type!='display' and (repeats=true or %extension.valueInteger=1)</code> extension I 0..0 url 1..1 uri "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" value[x] I 1..1 integer Value normative part of extension Documentation for this format XML Template <!-- maxOccurs --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension> JSON Template the specification.

{ // // from Element: " ] " " }
  Constraints ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div ) ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) ) ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div ) ext-1 : On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) ) ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )