DSTU2 Ballot Source
This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition for Sets expectations for data elements exchanged or maintained within data element registries according to requirements established by the structured data capture project
{
"resourceType": "StructureDefinition",
"id": "dataelement-sdc-de-sdcelement",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/dataelement-sdc-de-sdcelement",
"name": "Structured Data Capture Data Element Exchange",
"publisher": "U.S. Office of the National Coordinator (ONC)'s Standards and Infrastructure (S&I) Structured Data Capture project",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
}
]
}
],
"description": "Sets expectations for data elements exchanged or maintained within data element registries according to requirements established by the structured data capture project",
"status": "draft",
"date": "2014-04-21",
"type": "constraint",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/DataElement",
"snapshot": {
"element": [
{
"path": "DataElement",
"name": "SDCElement",
"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": 1,
"max": "1",
"type": [
{
"code": "DataElement"
}
],
"constraint": [
{
"key": "inv-2",
"severity": "error",
"human": "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"
}
],
"mapping": [
{
"identity": "dex",
"map": "RetrieveMetadata response"
},
{
"identity": "v2",
"map": "OM1"
},
{
"identity": "rim",
"map": "Observation[classCode=OBS, moodCode=DEFN]"
},
{
"identity": "iso11179",
"map": "Data_Element"
}
]
},
{
"path": "DataElement.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. 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",
"type": [
{
"code": "id"
}
]
},
{
"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",
"type": [
{
"code": "Meta"
}
]
},
{
"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",
"type": [
{
"code": "uri"
}
],
"isModifier": 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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"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",
"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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "DataElement.extension",
"name": "effectivePeriod",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-effective-period"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "documentReference",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-document-reference"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "administrativeStatus",
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "changeDescription",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-change-description"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "submitterOrganization",
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "registryOrganization",
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-registry-org"
}
],
"mustSupport": true
},
{
"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": "*",
"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 uri that is used to identify this element when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./id[use=INSTANCE]"
}
]
},
{
"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": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "id"
},
{
"identity": "v2",
"map": "OM1.2"
},
{
"identity": "rim",
"map": "./id[use=BUS]"
},
{
"identity": "loincstruc",
"map": "LOINC_NUM (the code is the identifier)"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier\n\nAs assigned by registering authority"
}
]
},
{
"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": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "version"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./id[use=VER]"
},
{
"identity": "loincstruc",
"map": "N/A"
},
{
"identity": "iso11179",
"map": "(Identified_Item).identifier.version"
}
]
},
{
"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": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "displayName"
},
{
"identity": "v2",
"map": "OM1.11"
},
{
"identity": "rim",
"map": "./title"
},
{
"identity": "loincstruc",
"map": "LONG_COMMON_NAME"
},
{
"identity": "iso11179",
"map": "(Designatable_Item).designation.sign\n\nacceptability=preferred in default context"
}
]
},
{
"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"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"name": "ConformanceUseContext",
"strength": "extensible",
"description": "Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/use-context"
}
},
"mapping": [
{
"identity": "v2",
"map": "OM1.18, OM1.42, OM1.46, OM7.3"
},
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=LIST, moodCode=EVN]/code"
},
{
"identity": "loincstruc",
"map": "COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"
},
{
"identity": "iso11179",
"map": "(Classifiable_Item).classifier"
}
]
},
{
"path": "DataElement.useContext.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",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.useContext.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "DataElement.useContext.extension",
"name": "classificationOrContext",
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context"
}
],
"mustSupport": true
},
{
"path": "DataElement.useContext.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"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.",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"max": "*",
"type": [
{
"code": "Coding"
}
],
"mapping": [
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
}
]
},
{
"path": "DataElement.useContext.text",
"short": "Plain text representation of the concept",
"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.",
"comments": "Very often the text is the same as a displayName of one of the codings.",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
}
]
},
{
"path": "DataElement.experimental",
"short": "If for testing purposes, not real usage",
"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.",
"comments": "Allows filtering of search data element definitions that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"experimental\"].value[type=BL]"
}
]
},
{
"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 vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"name": "ConformanceResourceStatus",
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/conformance-resource-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "MFE.1"
},
{
"identity": "rim",
"map": "./status\n(draft = new\n active = active\n retired = aborted)"
},
{
"identity": "loincstruc",
"map": "STATUS"
},
{
"identity": "iso11179",
"map": "(Administered_item).registration.state\n\nnew = Incomplete, Candidate, Recorded, Qualified\n\nactive = Standard, Preferred Standard, Application\n\nretired = Retired, Superceded, Historical"
}
]
},
{
"path": "DataElement.date",
"short": "Date for this version of the data element",
"definition": "The date that the status for this business version of the data element became effective. (I.e. Date the draft was created, date element became active or date element became retired).",
"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.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "revisionDate"
},
{
"identity": "v2",
"map": "OM1.21"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/time"
},
{
"identity": "loincstruc",
"map": "DATE_LAST_CHANGED"
},
{
"identity": "iso11179",
"map": "(Administered_item).last_change_date"
}
]
},
{
"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"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "./inboundRelationship[typeCode=SUBJ]/source[classCode=CONTRACT,moodCode=EVN].text"
}
]
},
{
"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": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "dex",
"map": "registrationAuthority"
},
{
"identity": "v2",
"map": "OM1.16"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]/name"
},
{
"identity": "loincstruc",
"map": "Fixed to Regenstrief or SOURCE"
},
{
"identity": "iso11179",
"map": "(Administered_Item).stewardship_record.organization.name"
}
]
},
{
"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": 1,
"max": "*",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "OM1.17"
},
{
"identity": "rim",
"map": "./participation[typeCode=AUT]/role[classCode=ASSIGN]/scoper[classCode=ORG,determinerCode=INSTANCE]"
},
{
"identity": "loincstruc",
"map": "N/A"
},
{
"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",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "DataElement.contact.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "DataElement.contact.extension",
"name": "contactAddress",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-contact-address"
}
],
"mustSupport": true
},
{
"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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "DataElement.contact.name",
"short": "Name of a 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": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"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": 1,
"max": "1",
"type": [
{
"code": "ContactPoint"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
}
]
},
{
"path": "DataElement.specificity",
"short": "comparable | fully-specified | equivalent | convertable | scaleable | flexible",
"definition": "Identifies how precise the data element is in its definition.",
"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).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"name": "DataElementSpecificity",
"strength": "required",
"description": "Indicates the degree of precision of the data element definition",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/dataelement-specificity"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./target[typeCode=SUBJ]/source[classCode=OBS, moodCode=EVN, code=\"granularity\"]/value"
}
]
},
{
"path": "DataElement.mapping",
"slicing": {
"discriminator": [
"uri"
],
"ordered": false,
"rules": "open"
},
"short": "External specification mapped to",
"definition": "Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "dex",
"map": "100;0"
},
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping",
"name": "ObjectClassPropertyMapping",
"short": "External specification mapped to",
"definition": "Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with.",
"min": 1,
"max": "1",
"mustSupport": true,
"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",
"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": "*",
"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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": 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"
}
],
"fixedId": "objclass-prop",
"mustSupport": true,
"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": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://healthit.gov/sdc/objectclassproperty",
"mustSupport": true,
"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"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.comments",
"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"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping",
"name": "OtherMapping",
"short": "External specification mapped to",
"definition": "Identifies a specification (other than a terminology) that the elements that make up the DataElement hav some correspondance with.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "inv-1",
"severity": "error",
"human": "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']))"
}
],
"mustSupport": true,
"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",
"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": "*",
"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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": 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"
}
],
"mustSupport": true,
"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"
}
],
"mustSupport": true,
"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"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
},
{
"path": "DataElement.mapping.comments",
"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"
}
],
"mustSupport": true,
"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 repetion. For complex data types, multiple repetitions will be present defining a nested structure using the \"path\" element.",
"min": 1,
"max": "*",
"type": [
{
"code": "ElementDefinition"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "rim",
"map": "N/A (MIF)"
}
]
}
]
},
"differential": {
"element": [
{
"path": "DataElement",
"name": "SDCElement",
"min": 1,
"max": "1",
"type": [
{
"code": "DataElement"
}
],
"constraint": [
{
"key": "inv-2",
"severity": "error",
"human": "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"
}
]
},
{
"path": "DataElement.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.extension",
"name": "effectivePeriod",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-effective-period"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "documentReference",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-document-reference"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "administrativeStatus",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "changeDescription",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-change-description"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "submitterOrganization",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org"
}
],
"mustSupport": true
},
{
"path": "DataElement.extension",
"name": "registryOrganization",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-registry-org"
}
],
"mustSupport": true
},
{
"path": "DataElement.url",
"mustSupport": true
},
{
"path": "DataElement.identifier",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.version",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.name",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.useContext",
"mustSupport": true
},
{
"path": "DataElement.useContext.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.useContext.extension",
"name": "classificationOrContext",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context"
}
],
"mustSupport": true
},
{
"path": "DataElement.experimental",
"mustSupport": true
},
{
"path": "DataElement.status",
"mustSupport": true
},
{
"path": "DataElement.date",
"mustSupport": true
},
{
"path": "DataElement.copyright",
"mustSupport": true
},
{
"path": "DataElement.publisher",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"path": "DataElement.contact",
"min": 1,
"max": "*",
"mustSupport": true
},
{
"path": "DataElement.contact.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.contact.extension",
"name": "contactAddress",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-contact-address"
}
],
"mustSupport": true
},
{
"path": "DataElement.contact.name",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.contact.telecom",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.specificity",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.mapping",
"slicing": {
"discriminator": [
"uri"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.mapping",
"name": "ObjectClassPropertyMapping",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.mapping.identity",
"type": [
{
"code": "id"
}
],
"fixedId": "objclass-prop",
"mustSupport": true
},
{
"path": "DataElement.mapping.uri",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://healthit.gov/sdc/objectclassproperty",
"mustSupport": true
},
{
"path": "DataElement.mapping.name",
"mustSupport": true
},
{
"path": "DataElement.mapping.comments",
"mustSupport": true
},
{
"path": "DataElement.mapping",
"name": "OtherMapping",
"constraint": [
{
"key": "inv-1",
"severity": "error",
"human": "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']))"
}
],
"mustSupport": true
},
{
"path": "DataElement.mapping.identity",
"mustSupport": true
},
{
"path": "DataElement.mapping.uri",
"mustSupport": true
},
{
"path": "DataElement.mapping.name",
"mustSupport": true
},
{
"path": "DataElement.mapping.comments",
"mustSupport": true
},
{
"path": "DataElement.element",
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.element.extension",
"name": "minLength",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/minLength"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"name": "regex",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/regex"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"name": "entryFormat",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/entryFormat"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"name": "minValue",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/minValue"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"name": "maxValue",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/maxValue"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"name": "maxDecimalPlaces",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"name": "question",
"comments": "...Need at least one primary question and one alternate question.",
"min": 2,
"max": "*",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/elementdefinition-question"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.extension",
"name": "allowedUnits",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.path",
"mustSupport": true
},
{
"path": "DataElement.element.name",
"mustSupport": true
},
{
"path": "DataElement.element.label",
"mustSupport": true
},
{
"path": "DataElement.element.code",
"mustSupport": true
},
{
"path": "DataElement.element.code.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.element.code.extension",
"name": "isDataElementConcept",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept"
}
],
"condition": [
"inv-2"
]
},
{
"path": "DataElement.element.definition",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.element.comments",
"mustSupport": true
},
{
"path": "DataElement.element.requirements",
"mustSupport": true
},
{
"path": "DataElement.element.alias",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"path": "DataElement.element.min",
"mustSupport": true
},
{
"path": "DataElement.element.max",
"mustSupport": true
},
{
"path": "DataElement.element.type",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.element.type.code",
"mustSupport": true
},
{
"path": "DataElement.element.defaultValue[x]"
},
{
"path": "DataElement.element.meaningWhenMissing"
},
{
"path": "DataElement.element.example[x]",
"mustSupport": true
},
{
"path": "DataElement.element.maxLength",
"mustSupport": true
},
{
"path": "DataElement.element.condition",
"mustSupport": true
},
{
"path": "DataElement.element.constraint",
"mustSupport": true
},
{
"path": "DataElement.element.constraint.key",
"mustSupport": true
},
{
"path": "DataElement.element.constraint.name",
"mustSupport": true
},
{
"path": "DataElement.element.constraint.severity",
"mustSupport": true
},
{
"path": "DataElement.element.constraint.human",
"mustSupport": true
},
{
"path": "DataElement.element.constraint.xpath",
"mustSupport": true
},
{
"path": "DataElement.element.mustSupport",
"min": 0,
"max": "0"
},
{
"path": "DataElement.element.binding",
"mustSupport": true
},
{
"path": "DataElement.element.binding.name",
"mustSupport": true
},
{
"path": "DataElement.element.binding.strength",
"mustSupport": true
},
{
"path": "DataElement.element.binding.description",
"mustSupport": true
},
{
"path": "DataElement.element.binding.valueSetReference",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"constraint": [
{
"key": "inv-3",
"severity": "error",
"human": "Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present",
"xpath": "count(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset'])=count(f:extension[@url='http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap'])"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.binding.valueSetReference.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.element.binding.valueSetReference.extension",
"name": "permittedValueValueset",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset"
}
],
"condition": [
"inv-3"
],
"mustSupport": true
},
{
"path": "DataElement.element.binding.valueSetReference.extension",
"name": "permittedValueConcepmap",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap"
}
],
"condition": [
"inv-3"
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping",
"slicing": {
"discriminator": [
"identity"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.element.mapping",
"name": "ClassPropertyMapping",
"short": "A mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.",
"definition": "A mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.",
"condition": [
"inv-2"
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.element.mapping.extension",
"name": "objectClass",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-objectClass"
}
],
"condition": [
"inv-1"
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping.extension.valueCoding",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping.extension",
"name": "property",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty"
}
],
"condition": [
"inv-1"
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping.extension.valueCoding",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping.identity",
"type": [
{
"code": "id"
}
],
"fixedId": "objclass-prop"
},
{
"path": "DataElement.element.mapping.map",
"short": "This should be expressed as \"[uri for object class code system]#[code for object class code system] | [uri for property code system]#[code for property code system]\".",
"definition": "This should be expressed as \"[uri for object class code system]#[code for object class code system] | [uri for property code system]#[code for property code system]\".",
"comments": "We express the mapping even though the class and property extensions already convey the data to ensure that systems that don't recognize the extensions still understand the mappings.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "DataElement.element.mapping",
"name": "OtherElementMapping",
"min": 0,
"max": "*",
"condition": [
"inv-2"
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "DataElement.element.mapping.extension",
"name": "MappingEquivalence",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence"
}
],
"mustSupport": true
},
{
"path": "DataElement.element.mapping.language",
"mustSupport": true,
"binding": {
"name": "DEXMappingLanguage",
"strength": "extensible",
"description": "Mime Types that correspond to the mapping languages supported by DEX",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/dex-mimetype"
}
}
},
{
"path": "DataElement.element.mapping.map",
"mustSupport": true
}
]
}
}
© HL7.org 2011+. FHIR DSTU (v0.5.0-5149) generated on Fri, Apr 3, 2015 14:31+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change