This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Describes a required data item
{ "resourceType": "StructureDefinition", "id": "cqif-basic-data", "url": "http://hl7.org/fhir/StructureDefinition/cqif-basic-data", "name": "Describes a required data item", "display": "data", "status": "draft", "publisher": "Health Level Seven, Inc. - CDS WG", "contact": [ { "telecom": [ { "system": "other", "value": "http://hl7.org/special/committees/dss" } ] } ], "date": "2015-05-30", "description": "Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.", "kind": "datatype", "constrainedType": "Extension", "abstract": false, "contextType": "resource", "context": [ "Basic" ], "base": "http://hl7.org/fhir/StructureDefinition/Extension", "snapshot": { "element": [ { "path": "Extension", "short": "Describes a required data item", "definition": "Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.", "min": 0, "max": "*", "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", "slicing": { "discriminator": [ "url" ], "ordered": true, "rules": "openAtEnd" }, "short": "Additional Content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension", "name": "type", "short": "The type of the required data", "definition": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.", "min": 1, "max": "1", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.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.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.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": "type", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.valueCode", "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": "code" } ], "binding": { "strength": "required", "description": "The type of the parameter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/operation-parameter-type" } }, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension", "name": "profile", "short": "The profile of the required data", "definition": "The profile of the required data, specified as the uri of the profile definition.", "min": 0, "max": "1", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.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.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.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": "profile", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.valueReference", "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": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ] } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension", "name": "mustSupport", "short": "Indicates that specific structure elements are referenced by the knowledge module", "definition": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.", "min": 0, "max": "*", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.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.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.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": "mustSupport", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.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" } ] }, { "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/cqif-basic-data", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.value[x]", "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": 0, "max": "0", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" }, { "code": "integer" }, { "code": "decimal" }, { "code": "base64Binary" }, { "code": "instant" }, { "code": "string" }, { "code": "uri" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "code" }, { "code": "oid" }, { "code": "id" }, { "code": "unsignedInt" }, { "code": "positiveInt" }, { "code": "markdown" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "Identifier" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Period" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "HumanName" }, { "code": "Address" }, { "code": "ContactPoint" }, { "code": "Timing" }, { "code": "Reference" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "path": "Extension", "short": "Describes a required data item", "definition": "Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.", "min": 0, "max": "*", "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension", "name": "type", "short": "The type of the required data", "definition": "The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.", "min": 1, "max": "1", "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "type" }, { "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "The type of the parameter", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/operation-parameter-type" } } }, { "path": "Extension.extension", "name": "profile", "short": "The profile of the required data", "definition": "The profile of the required data, specified as the uri of the profile definition.", "min": 0, "max": "1", "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "profile" }, { "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ] } ] }, { "path": "Extension.extension", "name": "mustSupport", "short": "Indicates that specific structure elements are referenced by the knowledge module", "definition": "Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.", "min": 0, "max": "*", "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "mustSupport" }, { "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "string" } ] }, { "path": "Extension.url", "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/cqif-basic-data" }, { "path": "Extension.value[x]", "min": 0, "max": "0" } ] } }
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.