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 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for conceptmap
{
"resourceType": "StructureDefinition",
"id": "ConceptMap",
"meta": {
"lastUpdated": "2015-04-03T14:24:32.000+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/ConceptMap",
"name": "ConceptMap",
"publisher": "HL7 FHIR Project (Vocabulary)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for ConceptMap Resource",
"status": "draft",
"date": "2015-04-03T14:24:32+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "ConceptMap",
"short": "A map from one set of concepts to one or more other concepts",
"definition": "A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.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": "ConceptMap.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": "ConceptMap.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": "ConceptMap.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": "ConceptMap.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": "ConceptMap.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": "ConceptMap.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.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": "ConceptMap.url",
"short": "Globally unique logical id for concept map",
"definition": "An absolute uri that is used to identify this concept map 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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.identifier",
"short": "Additional identifier for the concept map",
"definition": "Formal identifier that is used to identify this concept map 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": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ConceptMap.version",
"short": "Logical id for this version of the concept map",
"definition": "The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the concept map that have this same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.name",
"short": "Informal name for this concept map",
"definition": "A free text natural language name describing the concept map.",
"comments": "Not expected to be unique.",
"requirements": "Support human navigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.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 concept maps.",
"requirements": "Assist in searching for appropriate concept maps.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"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": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the concept map.",
"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 concept map. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ConceptMap.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": "*",
"isSummary": true
},
{
"path": "ConceptMap.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": "ConceptMap.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "ConceptMap.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": "ConceptMap.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the concept map.",
"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
},
{
"path": "ConceptMap.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
},
{
"path": "ConceptMap.description",
"short": "Human language description of the concept map",
"definition": "A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.",
"comments": "The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.",
"requirements": "Human understandability.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.requirements",
"short": "Why is this needed?",
"definition": "Explains why this concept map is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the concept map (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the concept map and/or its contents.",
"comments": "Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.status",
"short": "draft | active | retired",
"definition": "The status of the concept map.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"requirements": "Identify when/if the concept map should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"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": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ConceptMap.date",
"short": "Date for given status",
"definition": "The date that the concept map status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map.",
"requirements": "Need to know when a concept map was first legal for use or became withdrawn or replaced.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.source[x]",
"short": "Identifies the source of the concepts which are being mapped",
"definition": "The source value set that specifies the concepts that are being mapped.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.target[x]",
"short": "Provides context to the mappings",
"definition": "The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.element",
"short": "Mappings for a concept from the source set",
"definition": "Mappings for an individual concept in the source to one or more concepts in the target.",
"comments": "Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped mutliple times with different comments or dependencies.",
"alias": [
"code",
"concept",
"item"
],
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.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": "ConceptMap.element.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": "ConceptMap.element.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": "ConceptMap.element.codeSystem",
"short": "Code System (if value set crosses code systems)",
"definition": "An absolute URI that identifies the Code System (if the source is a value value set that crosses more than one code system).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.code",
"short": "Identifies element being mapped",
"definition": "Identity (code or path) or the element/item being mapped.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.dependsOn",
"name": "dependsOn",
"short": "Other elements required for this mapping (from context)",
"definition": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.",
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.dependsOn.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": "ConceptMap.element.dependsOn.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": "ConceptMap.element.dependsOn.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": "ConceptMap.element.dependsOn.element",
"short": "Reference to element/field/valueset mapping depends on",
"definition": "A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.codeSystem",
"short": "Code System (if necessary)",
"definition": "An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that cross code systems).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.code",
"short": "Value of the referenced element",
"definition": "Identity (code or path) or the element/item that the map depends on / refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.element.map",
"short": "Target of this map",
"definition": "A concept from the target value set that this concept maps to.",
"comments": "Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "cmd-1",
"severity": "error",
"human": "If the map is narrower or inexact, there SHALL be some comments",
"xpath": "exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
]
},
{
"path": "ConceptMap.element.map.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": "ConceptMap.element.map.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": "ConceptMap.element.map.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": "ConceptMap.element.map.codeSystem",
"short": "System of the target (if necessary)",
"definition": "An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).",
"comments": "Should be a version specific reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.map.code",
"short": "Code that identifies the target element",
"definition": "Identity (code or path) or the element/item that the map refers to.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.map.equivalence",
"short": "equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint",
"definition": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from source to target (e.g. the source is 'wider' than the target.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConceptMapEquivalence",
"strength": "required",
"description": "The degree of equivalence between concepts",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/concept-equivalence"
}
}
},
{
"path": "ConceptMap.element.map.comments",
"short": "Description of status/issues in mapping",
"definition": "A description of status/issues in mapping that conveys additional information not represented in the structured data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"cmd-1"
]
},
{
"path": "ConceptMap.element.map.product",
"short": "Other concepts that this mapping also produces",
"definition": "A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.",
"min": 0,
"max": "*",
"nameReference": "dependsOn"
}
]
},
"differential": {
"element": [
{
"path": "ConceptMap",
"short": "A map from one set of concepts to one or more other concepts",
"definition": "A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.url",
"short": "Globally unique logical id for concept map",
"definition": "An absolute uri that is used to identify this concept map 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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.identifier",
"short": "Additional identifier for the concept map",
"definition": "Formal identifier that is used to identify this concept map 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": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true
},
{
"path": "ConceptMap.version",
"short": "Logical id for this version of the concept map",
"definition": "The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the concept map that have this same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.name",
"short": "Informal name for this concept map",
"definition": "A free text natural language name describing the concept map.",
"comments": "Not expected to be unique.",
"requirements": "Support human navigation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.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 concept maps.",
"requirements": "Assist in searching for appropriate concept maps.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"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": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.publisher",
"short": "Name of the publisher (Organization or individual)",
"definition": "The name of the individual or organization that published the concept map.",
"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 concept map. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"path": "ConceptMap.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": "*",
"isSummary": true
},
{
"path": "ConceptMap.contact.name",
"short": "Name of a individual to contact",
"definition": "The name of an individual to contact regarding the concept map.",
"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
},
{
"path": "ConceptMap.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
},
{
"path": "ConceptMap.description",
"short": "Human language description of the concept map",
"definition": "A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.",
"comments": "The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.",
"requirements": "Human understandability.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.requirements",
"short": "Why is this needed?",
"definition": "Explains why this concept map is needed and why it's been constrained as it has.",
"comments": "This element does not describe the usage of the concept map (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.copyright",
"short": "Use and/or Publishing restrictions",
"definition": "A copyright statement relating to the concept map and/or its contents.",
"comments": "Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.status",
"short": "draft | active | retired",
"definition": "The status of the concept map.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"requirements": "Identify when/if the concept map should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"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": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.experimental",
"short": "If for testing purposes, not real usage",
"definition": "This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"path": "ConceptMap.date",
"short": "Date for given status",
"definition": "The date that the concept map status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map.",
"requirements": "Need to know when a concept map was first legal for use or became withdrawn or replaced.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "ConceptMap.source[x]",
"short": "Identifies the source of the concepts which are being mapped",
"definition": "The source value set that specifies the concepts that are being mapped.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.target[x]",
"short": "Provides context to the mappings",
"definition": "The target value set provides context to the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.",
"comments": "Should be a version specific reference. URIs SHOULD be absolute.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
],
"isSummary": true
},
{
"path": "ConceptMap.element",
"short": "Mappings for a concept from the source set",
"definition": "Mappings for an individual concept in the source to one or more concepts in the target.",
"comments": "Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped mutliple times with different comments or dependencies.",
"alias": [
"code",
"concept",
"item"
],
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.codeSystem",
"short": "Code System (if value set crosses code systems)",
"definition": "An absolute URI that identifies the Code System (if the source is a value value set that crosses more than one code system).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.code",
"short": "Identifies element being mapped",
"definition": "Identity (code or path) or the element/item being mapped.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.dependsOn",
"name": "dependsOn",
"short": "Other elements required for this mapping (from context)",
"definition": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.",
"min": 0,
"max": "*"
},
{
"path": "ConceptMap.element.dependsOn.element",
"short": "Reference to element/field/valueset mapping depends on",
"definition": "A reference to a specific concept that holds a coded value. This can be an element in a FHIR resource, or a specific reference to a data element in a different specification (e.g. v2) or a general reference to a kind of data field, or a reference to a value set with an appropriately narrow definition.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.codeSystem",
"short": "Code System (if necessary)",
"definition": "An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that cross code systems).",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.dependsOn.code",
"short": "Value of the referenced element",
"definition": "Identity (code or path) or the element/item that the map depends on / refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "ConceptMap.element.map",
"short": "Target of this map",
"definition": "A concept from the target value set that this concept maps to.",
"comments": "Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "cmd-1",
"severity": "error",
"human": "If the map is narrower or inexact, there SHALL be some comments",
"xpath": "exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
]
},
{
"path": "ConceptMap.element.map.codeSystem",
"short": "System of the target (if necessary)",
"definition": "An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).",
"comments": "Should be a version specific reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"path": "ConceptMap.element.map.code",
"short": "Code that identifies the target element",
"definition": "Identity (code or path) or the element/item that the map refers to.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"path": "ConceptMap.element.map.equivalence",
"short": "equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint",
"definition": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from source to target (e.g. the source is 'wider' than the target.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConceptMapEquivalence",
"strength": "required",
"description": "The degree of equivalence between concepts",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/concept-equivalence"
}
}
},
{
"path": "ConceptMap.element.map.comments",
"short": "Description of status/issues in mapping",
"definition": "A description of status/issues in mapping that conveys additional information not represented in the structured data.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"cmd-1"
]
},
{
"path": "ConceptMap.element.map.product",
"short": "Other concepts that this mapping also produces",
"definition": "A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.",
"min": 0,
"max": "*",
"nameReference": "dependsOn"
}
]
}
}
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 DSTU (v0.5.0-5149) generated on Fri, Apr 3, 2015 14:30+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change