STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 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 . Page versions: R5 R4B R4 R3 R2

Code.profile.json

Raw JSON (canonical form)

StructureDefinition for code

{
  "resourceType": "StructureDefinition",
  "id": "code",
  "meta": {
    "lastUpdated": "2016-12-06T12:22:34.981+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/code",
  "name": "code",
  "status": "draft",
  "publisher": "HL7 FHIR Standard",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2016-12-06T12:22:34+11:00",
  "description": "Base StructureDefinition for code type: A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents",
  "fhirVersion": "1.8.0",
  "kind": "primitive-type",
  "abstract": false,
  "type": "code",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/string",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "code",
        "path": "code",
        "short": "Primitive Type code",
        "definition": "A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents",
        "min": 0,
        "max": "*",
        "base": {
          "path": "code",
          "min": 0,
          "max": "*"
        },
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "children().count() > id.count()",
            "xpath": "@value|f:*|h:div",
            "source": "Element"
          }
        ]
      },
      {
        "id": "code.extension",
        "path": "code.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. 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.",
        "comments": "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"
          }
        ]
      },
      {
        "id": "code.value",
        "path": "code.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for code",
        "definition": "Primitive value for code",
        "min": 0,
        "max": "1",
        "base": {
          "path": "string.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/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:token"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
                  "valueString": "xsd:token"
                }
              ]
            }
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "code",
        "path": "code",
        "short": "Primitive Type code",
        "definition": "A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents",
        "min": 0,
        "max": "*"
      },
      {
        "id": "code.value",
        "path": "code.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for code",
        "definition": "Primitive value for code",
        "min": 0,
        "max": "1",
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/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:token"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
                  "valueString": "xsd:token"
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

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.