R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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: R5 R4B R4 R3 R2

String.profile.json

Modeling and Methodology Work GroupMaturity Level: N/ABallot Status: Informative

Raw JSON (canonical form)

StructureDefinition for string

{
  "resourceType": "StructureDefinition",
  "id": "string",
  "meta": {
    "lastUpdated": "2018-04-03T12:05:46.262+10:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "Normative"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/string",
  "name": "string",
  "status": "draft",
  "date": "2018-04-03T12:05:46+10:00",
  "publisher": "HL7 FHIR Standard",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "Base StructureDefinition for string Type: A sequence of Unicode characters",
  "fhirVersion": "3.3.0",
  "kind": "primitive-type",
  "abstract": false,
  "type": "string",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "string",
        "path": "string",
        "short": "Primitive Type string",
        "definition": "A sequence of Unicode characters",
        "comment": "Note that FHIR strings SHALL not exceed 1MB in size",
        "min": 0,
        "max": "*",
        "base": {
          "path": "string",
          "min": 0,
          "max": "*"
        },
        "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"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "string.id",
        "path": "string.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references)",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "string.extension",
        "path": "string.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the resource. 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 can 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"
          }
        ],
        "isModifier": false,
        "isSummary": false
      },
      {
        "id": "string.value",
        "path": "string.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for string",
        "definition": "The actual value",
        "min": 0,
        "max": "1",
        "base": {
          "path": "string.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/regex",
                "valueString": "\\s*(\\S|\\s)*"
              }
            ],
            "_code": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
                  "valueString": "string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
                  "valueString": "xsd:string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
                  "valueString": "xsd:string"
                }
              ]
            }
          }
        ],
        "maxLength": 1048576,
        "isModifier": false,
        "isSummary": false
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "string",
        "path": "string",
        "short": "Primitive Type string",
        "definition": "A sequence of Unicode characters",
        "comment": "Note that FHIR strings SHALL not exceed 1MB in size",
        "min": 0,
        "max": "*"
      },
      {
        "id": "string.value",
        "path": "string.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for string",
        "definition": "Primitive value for string",
        "min": 0,
        "max": "1",
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/regex",
                "valueString": "\\s*(\\S|\\s)*"
              }
            ],
            "_code": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
                  "valueString": "string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
                  "valueString": "xsd:string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
                  "valueString": "xsd:string"
                }
              ]
            }
          }
        ],
        "maxLength": 1048576
      }
    ]
  }
}

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.