STU 3 Candidate
This page is part of the FHIR Specification (v1.4.0: STU 3 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 
. Page versions: R3 R2
StructureDefinition for dataelement
{
"resourceType": "StructureDefinition",
"id": "DataElement",
"meta": {
"lastUpdated": "2016-03-31T08:01:25.570+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/DataElement",
"name": "DataElement",
"status": "draft",
"publisher": "Health Level Seven International (Orders and Observations)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/orders/index.cfm"
}
]
}
],
"date": "2016-03-31T08:01:25+11:00",
"description": "Base StructureDefinition for DataElement Resource",
"fhirVersion": "1.4.0",
"mapping": [
{
"identity": "dex",
"uri": "http://wiki.ihe.net/index.php?title=Data_Element_Exchange",
"name": "IHE Data Element Exchange (DEX)"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "iso11179",
"uri": "http://metadata-standards.org/11179/",
"name": "ISO 11179"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "loinc",
"uri": "http://loinc.org",
"name": "LOINC"
}
],
"kind": "resource",
"abstract": false,
"baseType": "DomainResource",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"path": "DataElement",
"short": "Resource data element",
"definition": "The formal description of a single piece of information that can be gathered and reported.",
"comments": "Often called a clinical template.",
"alias": [
"Master Observation",
"Data Element",
"CDE"
],
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dex",
"map": "RetrieveMetadata response"
},
{
"identity": "v2",
"map": "OM1"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=DEFN]"
},
{
"identity": "iso11179",
"map": "Data_Element"
},
{
"identity": "w5",
"map": "conformance.content"
}
]
},
{
"path": "DataElement.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"path": "DataElement.meta",
"short": "Metadata about the resource",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"path": "DataElement.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "DataElement.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "DataElement.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "DataElement.contained",
"short": "Contained, inline Resources",
"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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.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": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.url",
"short": "Globally unique logical id for data element",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./id[use=INSTANCE]"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier As assigned by registering authority"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "DataElement.identifier",
"short": "Logical id to reference this data element",
"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.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "id"
},
{
"identity": "loinc",
"map": "LOINC_NUM (the code is the identifier)"
},
{
"identity": "v2",
"map": "OM1.2"
},
{
"identity": "rim",
"map": "./id[use=BUS]"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "DataElement.version",
"short": "Logical id for this version of the data element",
"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.",
"comments": "N/A.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "version"
},
{
"identity": "loinc",
"map": "N/A"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./id[use=VER]"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier.version"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"path": "DataElement.status",
"short": "draft | active | retired",
"definition": "The status of the data element.",
"requirements": "Allows filtering of data elements that are appropriate for use.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conformance-resource-status"
}
},
"mapping": [
{
"identity": "loinc",
"map": "STATUS"
},
{
"identity": "v2",
"map": "MFE.1"
},
{
"identity": "rim",
"map": "./status (draft = new active = active retired = aborted)"
},
{
"identity": "iso11179",
"map": "(Administered_item).registration.state new = Incomplete, Candidate, Recorded, Qualified active = Standard, Preferred Standard, Application retired = Retired, Superseded, Historical"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "DataElement.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search data element definitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"experimental\"].value[type=BL]"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "DataElement.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the data element.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the data element. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "registrationAuthority"
},
{
"identity": "loinc",
"map": "Fixed to Regenstrief or SOURCE"
},
{
"identity": "v2",
"map": "OM1.16"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]/name"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.name"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"path": "DataElement.date",
"short": "Date for this version of the data element",
"definition": "The date 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 substantive content of the data element changes.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "revisionDate"
},
{
"identity": "loinc",
"map": "DATE_LAST_CHANGED"
},
{
"identity": "v2",
"map": "OM1.21"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/time"
},
{
"identity": "iso11179",
"map": "(Administered_item).last_change_date"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "DataElement.name",
"short": "Descriptive label for this element definition",
"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.",
"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.).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "displayName"
},
{
"identity": "loinc",
"map": "LONG_COMMON_NAME"
},
{
"identity": "v2",
"map": "OM1.11"
},
{
"identity": "rim",
"map": "./title"
},
{
"identity": "iso11179",
"map": "(Designatable_Item).designation.sign acceptability=preferred in default context"
}
]
},
{
"path": "DataElement.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "loinc",
"map": "N/A"
},
{
"identity": "v2",
"map": "OM1.17"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.[email_address, phone_number, uri]"
}
]
},
{
"path": "DataElement.contact.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": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.contact.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 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": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.contact.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.contact.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact regarding the data element.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "DataElement.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "DataElement.useContext",
"short": "Content intends to support these contexts",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/use-context"
}
},
"mapping": [
{
"identity": "loinc",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
},
{
"identity": "v2",
"map": "OM1.18, OM1.42, OM1.46, OM7.3"
},
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code"
},
{
"identity": "iso11179",
"map": "(Classifiable_Item).classifier"
}
]
},
{
"path": "DataElement.copyright",
"short": "Use and/or publishing restrictions",
"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.",
"comments": "The copyright statement does not apply to values for the data element, only to its definition.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=CONTRACT,moodCode=EVN].text"
}
]
},
{
"path": "DataElement.stringency",
"short": "comparable | fully-specified | equivalent | convertable | scaleable | flexible",
"definition": "Identifies how precise the data element is in its definition.",
"requirements": "Allows determining 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).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicates the degree of precision of the data element definition.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dataelement-stringency"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./target[typeCode=SUBJ]/source[classCode=OBS, moodCode=EVN, code=\"granularity\"]/value"
}
]
},
{
"path": "DataElement.mapping",
"short": "External specification mapped to",
"definition": "Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "dex",
"map": "100;0"
},
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.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": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.mapping.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 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": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.mapping.modifierExtension",
"short": "Extensions that cannot be ignored",
"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.",
"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",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An internal id that is used to identify this mapping set when specific mappings are made on a per-element basis.",
"comments": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comments": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.comment",
"short": "Versions, Issues, Scope limitations etc.",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.element",
"short": "Definition of element",
"definition": "Defines the structure, type, allowed values and other constraining characteristics of the data element.",
"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.",
"requirements": "1.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"constraint": [
{
"key": "dae-1",
"severity": "error",
"human": "No base allowed",
"expression": "base.empty()",
"xpath": "not(exists(f:base))"
},
{
"key": "dae-2",
"severity": "error",
"human": "No slicing allowed",
"expression": "slicing.empty()",
"xpath": "not(exists(f:slicing))"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DataElement",
"short": "Resource data element",
"definition": "The formal description of a single piece of information that can be gathered and reported.",
"comments": "Often called a clinical template.",
"alias": [
"Master Observation",
"Data Element",
"CDE"
],
"min": 0,
"max": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "dex",
"map": "RetrieveMetadata response"
},
{
"identity": "v2",
"map": "OM1"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=DEFN]"
},
{
"identity": "iso11179",
"map": "Data_Element"
},
{
"identity": "w5",
"map": "conformance.content"
}
]
},
{
"path": "DataElement.url",
"short": "Globally unique logical id for data element",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./id[use=INSTANCE]"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier As assigned by registering authority"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "DataElement.identifier",
"short": "Logical id to reference this data element",
"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.",
"comments": "Typically, this is used for values that can go in a v3 II data type.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "id"
},
{
"identity": "loinc",
"map": "LOINC_NUM (the code is the identifier)"
},
{
"identity": "v2",
"map": "OM1.2"
},
{
"identity": "rim",
"map": "./id[use=BUS]"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"path": "DataElement.version",
"short": "Logical id for this version of the data element",
"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.",
"comments": "N/A.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "version"
},
{
"identity": "loinc",
"map": "N/A"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./id[use=VER]"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier.version"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"path": "DataElement.status",
"short": "draft | active | retired",
"definition": "The status of the data element.",
"requirements": "Allows filtering of data elements that are appropriate for use.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conformance-resource-status"
}
},
"mapping": [
{
"identity": "loinc",
"map": "STATUS"
},
{
"identity": "v2",
"map": "MFE.1"
},
{
"identity": "rim",
"map": "./status (draft = new active = active retired = aborted)"
},
{
"identity": "iso11179",
"map": "(Administered_item).registration.state new = Incomplete, Candidate, Recorded, Qualified active = Standard, Preferred Standard, Application retired = Retired, Superseded, Historical"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "DataElement.experimental",
"short": "If for testing purposes, not real usage",
"definition": "A flag to indicate that this search data element definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of search data element definitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"experimental\"].value[type=BL]"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"path": "DataElement.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the data element.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the data element. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "registrationAuthority"
},
{
"identity": "loinc",
"map": "Fixed to Regenstrief or SOURCE"
},
{
"identity": "v2",
"map": "OM1.16"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]/name"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.name"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"path": "DataElement.date",
"short": "Date for this version of the data element",
"definition": "The date 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 substantive content of the data element changes.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "revisionDate"
},
{
"identity": "loinc",
"map": "DATE_LAST_CHANGED"
},
{
"identity": "v2",
"map": "OM1.21"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/time"
},
{
"identity": "iso11179",
"map": "(Administered_item).last_change_date"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"path": "DataElement.name",
"short": "Descriptive label for this element definition",
"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.",
"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.).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "displayName"
},
{
"identity": "loinc",
"map": "LONG_COMMON_NAME"
},
{
"identity": "v2",
"map": "OM1.11"
},
{
"identity": "rim",
"map": "./title"
},
{
"identity": "iso11179",
"map": "(Designatable_Item).designation.sign acceptability=preferred in default context"
}
]
},
{
"path": "DataElement.contact",
"short": "Contact details of the publisher",
"definition": "Contacts to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "loinc",
"map": "N/A"
},
{
"identity": "v2",
"map": "OM1.17"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.[email_address, phone_number, uri]"
}
]
},
{
"path": "DataElement.contact.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact regarding the data element.",
"comments": "If there is no named individual, the telecom is for the organization as a whole.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./name"
}
]
},
{
"path": "DataElement.contact.telecom",
"short": "Contact details for individual or publisher",
"definition": "Contact details for individual (if a name was provided) or the publisher.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "DataElement.useContext",
"short": "Content intends to support these contexts",
"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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/use-context"
}
},
"mapping": [
{
"identity": "loinc",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
},
{
"identity": "v2",
"map": "OM1.18, OM1.42, OM1.46, OM7.3"
},
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code"
},
{
"identity": "iso11179",
"map": "(Classifiable_Item).classifier"
}
]
},
{
"path": "DataElement.copyright",
"short": "Use and/or publishing restrictions",
"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.",
"comments": "The copyright statement does not apply to values for the data element, only to its definition.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=CONTRACT,moodCode=EVN].text"
}
]
},
{
"path": "DataElement.stringency",
"short": "comparable | fully-specified | equivalent | convertable | scaleable | flexible",
"definition": "Identifies how precise the data element is in its definition.",
"requirements": "Allows determining 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).",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicates the degree of precision of the data element definition.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/dataelement-stringency"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./target[typeCode=SUBJ]/source[classCode=OBS, moodCode=EVN, code=\"granularity\"]/value"
}
]
},
{
"path": "DataElement.mapping",
"short": "External specification mapped to",
"definition": "Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "dex",
"map": "100;0"
},
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.identity",
"short": "Internal id when this mapping is used",
"definition": "An internal id that is used to identify this mapping set when specific mappings are made on a per-element basis.",
"comments": "The specification is described once, with general comments, and then specific mappings are made that reference this declaration.",
"min": 1,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.uri",
"short": "Identifies what this mapping refers to",
"definition": "An absolute URI that identifies the specification that this mapping is expressed to.",
"comments": "A formal identity for the specification being mapped to helps with identifying maps consistently.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.name",
"short": "Names what this mapping refers to",
"definition": "A name for the specification that is being mapped to.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.comment",
"short": "Versions, Issues, Scope limitations etc.",
"definition": "Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.element",
"short": "Definition of element",
"definition": "Defines the structure, type, allowed values and other constraining characteristics of the data element.",
"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.",
"requirements": "1.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"constraint": [
{
"key": "dae-1",
"severity": "error",
"human": "No base allowed",
"expression": "base.empty()",
"xpath": "not(exists(f:base))"
},
{
"key": "dae-2",
"severity": "error",
"human": "No slicing allowed",
"expression": "slicing.empty()",
"xpath": "not(exists(f:slicing))"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
}
]
}
}
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.
© HL7.org 2011+. FHIR STU3 Candidate (v1.4.0-8139) generated on Thu, Mar 31, 2016 08:08+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change