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.2.0",
  "kind": "datatype",
  "constrainedType": "Extension",
  "abstract": false,
  "contextType": "resource",
  "context": [
    "StructureDefinition"
  ],
  "base": "http://hl7.org/fhir/StructureDefinition/Extension",
  "snapshot": {
    "element": [
      {
        "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": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "path": "Extension.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": "Extension.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Extension.extension",
        "name": "extension",
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Extension.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "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 should be version specific.  This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.",
        "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"
          }
        ]
      },
      {
        "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": [
      {
        "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",
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "path": "Extension.extension",
        "name": "extension",
        "max": "0"
      },
      {
        "path": "Extension.url",
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/datadictionary"
      },
      {
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}