Extension-datadictionary.json

Associates the structure definition with a collection of Data Elements

{
  "resourceType": "StructureDefinition",
  "id": "datadictionary",
  "url": "http://hl7.org/fhir/StructureDefinition/datadictionary",
  "name": "Associates the structure definition with a collection of Data Elements",
  "display": "Data Dictionary",
  "status": "draft",
  "publisher": "Health Level Seven, Inc. - FHIR Core WG",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/special/committees/FHIR"
        }
      ]
    }
  ],
  "date": "2014-01-31",
  "description": "This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri the defines a query that identifies the collection of relevant data elements\n\nThis extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements.\n\nFor Observation:\n* Observation.code must be associated with a matching Data Element by DataElement.code. \n* The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower)\n* the unit and the quantity value should conform to the rules laid down in the matching Data Element\n\nFor Questionnaire:\n* todo.",
  "fhirVersion": "1.6.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "contextType": "resource",
  "context": [
    "StructureDefinition"
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements",
        "path": "Extension",
        "short": "Associates the structure definition with a collection of Data Elements",
        "definition": "This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri the defines a query that identifies the collection of relevant data elements\n\nThis extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements.\n\nFor Observation:\n* Observation.code must be associated with a matching Data Element by DataElement.code. \n* The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower)\n* the unit and the quantity value should conform to the rules laid down in the matching Data Element\n\nFor Questionnaire:\n* todo.",
        "comments": "The query can select a set of data element resources, or identify a bundle that is a collection of data elements.",
        "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": "children().count() > id.count()",
            "xpath": "@value|f:*|h:div"
          },
          {
            "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')])"
          }
        ]
      },
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements.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": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements.extension:extension",
        "path": "Extension.extension",
        "name": "extension",
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements.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.",
        "comments": "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://hl7.org/fhir/StructureDefinition/datadictionary",
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements.valueString",
        "path": "Extension.valueString",
        "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": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements",
        "path": "Extension",
        "short": "Associates the structure definition with a collection of Data Elements",
        "definition": "This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri the defines a query that identifies the collection of relevant data elements\n\nThis extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements.\n\nFor Observation:\n* Observation.code must be associated with a matching Data Element by DataElement.code. \n* The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower)\n* the unit and the quantity value should conform to the rules laid down in the matching Data Element\n\nFor Questionnaire:\n* todo.",
        "comments": "The query can select a set of data element resources, or identify a bundle that is a collection of data elements.",
        "min": 0,
        "max": "1"
      },
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements.extension:extension",
        "path": "Extension.extension",
        "name": "extension",
        "max": "0"
      },
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements.url",
        "path": "Extension.url",
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/datadictionary"
      },
      {
        "id": "Extension:associatesthestructuredefinitionwithacollectionofdataelements.value[x]",
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}