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
Definitions for the sdcde-dataelement Profile.
DataElement(SDCDE-DataElement) | |
Definition | The formal description of a single piece of information that can be gathered and reported. |
Control | 0..* |
Type | DataElement |
Alternate Names | Master Observation, Data Element, CDE |
Comments | Often called a clinical template. |
Invariants | Defined on this element inv-2: One and only one DataElement.code must have is-data-element-concept set to "true" (xpath: count(f:code/f:extension[@uri='http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept'])=1) |
DataElement.id | |
Definition | The logical id of the resource, as used in the url for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
DataElement.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
DataElement.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
DataElement.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
DataElement.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
DataElement.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
DataElement.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-effective-period) | |
Definition | Identifies the date on which the element became (or is expected to become) active and the date on which the element became (or is expected to become) retired. |
Control | 0..1 |
Type | Extension (Extension Type: Period) |
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-document-reference) | |
Definition | Identifies a document that conveys some sort of information related to the data element. |
Control | 0..1 |
Type | Extension (Extension Type: Reference(DocumentReference)) |
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status) | |
Definition | Identifies internal processing status for the data element. E.g. "Under review". |
Control | 0..1 |
Type | Extension (Extension Type: CodeableConcept) |
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-change-description) | |
Definition | Summarizes changes to the data element since the previous version. |
Control | 0..1 |
Type | Extension (Extension Type: string) |
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org) | |
Definition | Organization responsible for submitting the data element to its registry. |
Control | 0..1 |
Type | Extension (Extension Type: Reference(Organization)) |
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-registry-org) | |
Definition | The organization that is the custodian for this data element. |
Control | 0..1 |
Type | Extension (Extension Type: Reference(Organization)) |
DataElement.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
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. |
DataElement.url | |
Definition | An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published. |
Control | 1..1 |
Type | uri |
Must Support | true |
DataElement.identifier | |
Definition | Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance. |
Control | 1..1 |
Type | Identifier |
Must Support | true |
Comments | Typically, this is used for values that can go in a v3 II data type. |
DataElement.version | |
Definition | The identifier that is used to identify this version of the data element when it is referenced in a StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | There may be multiple resource versions of the data element that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control. |
Comments | N/A. |
DataElement.name | |
Definition | The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used. |
Control | 1..1 |
Type | string |
Must Support | true |
Comments | This may be similar to the question used to prompt someone for a data element value, but the purpose is communicating about the data element, not asking the question. (Refer to the 'question' element for the latter.). |
DataElement.status | |
Definition | The status of the data element. |
Control | 1..1 |
Binding | The lifecycle status of a Value Set or Concept Map The codes SHALL be taken from ConformanceResourceStatus |
Type | code |
Is Modifier | true |
Must Support | true |
Requirements | Allows filtering of data elements that are appropriate for use vs. not. |
DataElement.experimental | |
Definition | A flag to indicate that this search data elemnt definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Control | 0..1 |
Type | boolean |
Must Support | true |
Comments | Allows filtering of search data element definitions that are appropriate for use vs. not. |
DataElement.publisher | |
Definition | The name of the individual or organization that published the data element. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Helps establish the "authority/credibility" of the data element. May also allow for contact. |
Comments | Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. |
DataElement.contact | |
Definition | Contacts to assist a user in finding and communicating with the publisher. |
Control | 1..* |
Type | BackboneElement |
Must Support | true |
Comments | May be a web site, an email address, a telephone number (tel:), etc. |
DataElement.contact.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
DataElement.contact.extension (http://hl7.org/fhir/StructureDefinition/11179-de-contact-address) | |
Definition | Postal address for a contact for the data element. |
Control | 0..1 |
Type | Extension (Extension Type: Address) |
DataElement.contact.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
DataElement.contact.name | |
Definition | The name of an individual to contact regarding the data element. |
Control | 1..1 |
Type | string |
Must Support | true |
Comments | If there is no named individual, the telecom is for the organization as a whole. |
DataElement.contact.telecom | |
Definition | Contact details for individual (if a name was provided) or the publisher. |
Control | 1..1 |
Type | ContactPoint |
Must Support | true |
DataElement.date | |
Definition | The date that this version of the Data Element was published. The date must change when the business version changes, if it does, and it must change if the status code changes. in addition, it should change when the substantiative content of the data element changes. |
Control | 0..1 |
Type | dateTime |
Must Support | true |
Comments | This refers to the "business" version - the DataElement.version which changes based on business processes. It does not refer to the date of the RESTful version which is part of the resource metadata. Additional specific dates may be added as extensions. |
DataElement.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of data element definitions. |
Control | 0..* |
Binding | Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within The codes SHALL be taken from Context of Use ValueSet; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Must Support | true |
DataElement.useContext.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
DataElement.useContext.extension (http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context) | |
Definition | Identifies whether the useContext is a true context or a classification. |
Control | 1..1 |
Type | Extension (Extension Type: code) |
DataElement.useContext.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
DataElement.useContext.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
DataElement.copyright | |
Definition | A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element. |
Control | 0..1 |
Type | string |
Must Support | true |
Alternate Names | License, Restrictions |
Comments | The copyright statement does not apply to values for the data element, only to its definition. |
DataElement.stringency | |
Definition | Identifies how precise the data element is in its definition. |
Control | 1..1 |
Binding | Indicates the degree of precision of the data element definition The codes SHALL be taken from DataElementStringency |
Type | code |
Must Support | true |
Requirements | Allows determining whether the degree of comparability of data element instances - less granular data elements result in data that is less comparable (or at least requires more work to compare). |
Fixed Value | comparable |
DataElement.mapping | |
Definition | Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with. |
Control | 0..* |
Type | BackboneElement |
Slicing | This element introduces a set of slices. The slicing rules are:
|
DataElement.mapping(ObjectClassPropertyMapping) | |
Definition | Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with. |
Control | 1..1 |
Type | BackboneElement |
Must Support | true |
DataElement.mapping.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
DataElement.mapping.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
DataElement.mapping.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
DataElement.mapping.identity | |
Definition | An Internal id that is used to identify this mapping set when specific mappings are made on a per-element basis. |
Control | 1..1 |
Type | id |
Must Support | true |
Comments | The specification is described once, with general comments, and then specific mappings are made that reference this declaration. |
Fixed Value | objclass-prop |
DataElement.mapping.uri | |
Definition | An absolute URI that identifies the specification that this mapping is expressed to. |
Control | 1..1 |
Type | uri |
Must Support | true |
Comments | A formal identity for the specification being mapped to helps with identifying maps consistently. |
Fixed Value | http://healthit.gov/sdc/objectclassproperty |
DataElement.mapping.name | |
Definition | A name for the specification that is being mapped to. |
Control | 0..1 |
Type | string |
Must Support | true |
DataElement.mapping.comments | |
Definition | Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
Control | 0..1 |
Type | string |
Must Support | true |
DataElement.mapping(OtherMapping) | |
Definition | Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with. |
Control | 0..* |
Type | BackboneElement |
Must Support | true |
Invariants | Defined on this element inv-1: Property extension can only be specified if ObjectClass extension is present (xpath: exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-objectClass']) or not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-property']))) |
DataElement.mapping.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
DataElement.mapping.extension | |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
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. |
DataElement.mapping.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
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. |
DataElement.mapping.identity | |
Definition | An Internal id that is used to identify this mapping set when specific mappings are made on a per-element basis. |
Control | 1..1 |
Type | id |
Must Support | true |
Comments | The specification is described once, with general comments, and then specific mappings are made that reference this declaration. |
DataElement.mapping.uri | |
Definition | An absolute URI that identifies the specification that this mapping is expressed to. |
Control | 0..1 |
Type | uri |
Must Support | true |
Comments | A formal identity for the specification being mapped to helps with identifying maps consistently. |
DataElement.mapping.name | |
Definition | A name for the specification that is being mapped to. |
Control | 0..1 |
Type | string |
Must Support | true |
DataElement.mapping.comments | |
Definition | Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
Control | 0..1 |
Type | string |
Must Support | true |
DataElement.element | |
Definition | Defines the structure, type, allowed values and other constraining characteristics of the data element. |
Control | 1..* |
Type | ElementDefinition |
Must Support | true |
Requirements | 1. |
Comments | For simple data types there will only be one repetition. For complex data types, multiple repetitions will be present defining a nested structure using the "path" element. |
Invariants | Defined on this element dae-1: No base allowed (xpath: not(exists(f:base))) dae-2: No slicing allowed (xpath: not(exists(f:slicing))) |