. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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
Profile for conceptmap
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A statement of relationships from one set of concepts to one or more other concept systems.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap\"><b>ConceptMap</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"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.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name describing the concept map.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of the individual or organization that published the concept map.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Human language description of the concept map<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A copyright statement relating to the concept map and/or its contents.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.copyright\"><b>copyright</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">About the concept map or its content</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the concept map (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that the concept map status was last changed.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The source value set that specifies the concepts that are being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Identifies the source value set which is being mapped<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"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.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.target\"><b>target</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"valueset.html#ValueSet\">ValueSet</a>)</span> <span style=\"color: navy\">Provides context to the mappings<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></target>\r\n <<a title=\"Mappings for a concept from the source valueset.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept\"><b>concept</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Mappings for a concept from the source valueset --></span>\r\n <<a title=\"System that defines the concept being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">System that defines the concept being mapped</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identifies concept being mapped.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Identifies concept being mapped</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified value.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn\"><b>dependsOn</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Other concepts required for this mapping (from context) --></span>\r\n <<a title=\"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.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.concept\"><b>concept</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Reference to element/field/valueset provides the context</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"System for a concept in the referenced concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">System for a concept in the referenced concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code for a concept in the referenced concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.dependsOn.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code for a concept in the referenced concept</span><span style=\"color: Gray\"> --></span>\r\n </dependsOn>\r\n <<a title=\"A concept from the target value set that this concept maps to.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map\"><b>map</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> A concept from the target value set that this concept maps to --></span>\r\n <<a title=\"System of the target.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: If a code is provided, a system SHALL be provided\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">System of the target</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code that identifies the target concept.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Code that identifies the target concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint (this element modifies the meaning of other elements)\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.equivalence\"><span style=\"text-decoration: underline\"><b>equivalence</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"concept-equivalence.html\">equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Description of status/issues in mapping.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.comments\"><b>comments</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: If the map is narrower, there SHALL be some comments\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Description of status/issues in mapping</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set 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.\" class=\"dict\" href=\"conceptmap-definitions.html#ConceptMap.concept.map.product\"><b>product</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ConceptMap.concept.dependsOn</span> <span style=\"color: navy\">Other concepts that this mapping also produces</span><span style=\"color: Gray\"> --></span></product>\r\n </map>\r\n </concept>\r\n</ConceptMap>\r\n</pre></div>"
},
"name": "conceptmap",
"publisher": "FHIR Project",
"description": "Basic Profile. A statement of relationships from one set of concepts to one or more other concept systems.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage A concept map defines a mapping from a concept defined in one system to one or more concepts defined in other systems. Mappings are always framed within the concept of value sets - they are specific to a context of use.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "ConceptMap",
"publish": true,
"element": [
{
"path": "ConceptMap",
"definition": {
"short": "A statement of relationships from one set of concepts to one or more other concept systems",
"formal": "A statement of relationships from one set of concepts to one or more other concept systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.identifier",
"definition": {
"short": "Logical id to reference this concept map",
"formal": "The identifier that is used to identify this concept map when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.version",
"definition": {
"short": "Logical id for this version of the concept map",
"formal": "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"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.name",
"definition": {
"short": "Informal name for this concept map",
"formal": "A free text natural language name describing the concept map.",
"comments": "Not expected to be unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.publisher",
"definition": {
"short": "Name of the publisher (Organization or individual)",
"formal": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.telecom",
"definition": {
"short": "Contact information of the publisher",
"formal": "Contacts of the publisher to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.description",
"definition": {
"short": "Human language description of the concept map",
"formal": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.copyright",
"definition": {
"short": "About the concept map or its content",
"formal": "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"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.status",
"definition": {
"short": "draft | active | retired",
"formal": "The status of the concept map.",
"comments": "Allows filtering of ConceptMaps that are appropriate for use.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ValueSetStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/valueset-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.experimental",
"definition": {
"short": "If for testing purposes, not real usage",
"formal": "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"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.date",
"definition": {
"short": "Date for given status",
"formal": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ConceptMap.source",
"definition": {
"short": "Identifies the source value set which is being mapped",
"formal": "The source value set that specifies the concepts that are being mapped.",
"comments": "Should be a version specific reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ValueSet"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.target",
"definition": {
"short": "Provides context to the mappings",
"formal": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/ValueSet"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept",
"definition": {
"short": "Mappings for a concept from the source valueset",
"formal": "Mappings for a concept from the source valueset.",
"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.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "ConceptMap.concept.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.system",
"definition": {
"short": "System that defines the concept being mapped",
"formal": "System that defines the concept being mapped.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.code",
"definition": {
"short": "Identifies concept being mapped",
"formal": "Identifies concept being mapped.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn",
"definition": {
"short": "Other concepts required for this mapping (from context)",
"formal": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified concept can be resolved, and it has the specified value.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.concept",
"definition": {
"short": "Reference to element/field/valueset provides the context",
"formal": "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"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.system",
"definition": {
"short": "System for a concept in the referenced concept",
"formal": "System for a concept in the referenced concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.dependsOn.code",
"definition": {
"short": "Code for a concept in the referenced concept",
"formal": "Code for a concept in the referenced concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map",
"definition": {
"short": "A concept from the target value set that this concept maps to",
"formal": "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": "2",
"severity": "error",
"human": "If a code is provided, a system SHALL be provided",
"xpath": "exists(f:system) or not(exists(f:code))"
},
{
"key": "1",
"severity": "error",
"human": "If the map is narrower, there SHALL be some comments",
"xpath": "exists(f:comments) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.system",
"definition": {
"short": "System of the target",
"formal": "System of the target.",
"comments": "Should be a version specific reference.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.code",
"definition": {
"short": "Code that identifies the target concept",
"formal": "Code that identifies the target concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.equivalence",
"definition": {
"short": "equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint",
"formal": "equal | equivalent | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ConceptMapEquivalence",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/concept-equivalence"
}
}
}
},
{
"path": "ConceptMap.concept.map.comments",
"definition": {
"short": "Description of status/issues in mapping",
"formal": "Description of status/issues in mapping.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ConceptMap.concept.map.product",
"definition": {
"short": "Other concepts that this mapping also produces",
"formal": "A set of additional outcomes from this mapping to other value sets. To properly execute this mapping, the specified value set 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": "ConceptMap.concept.dependsOn",
"isModifier": false
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "date",
"type": "date",
"documentation": "The concept map publication date",
"xpath": "f:ConceptMap/f:date"
},
{
"name": "dependson",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context",
"xpath": "f:ConceptMap/f:concept/f:dependsOn/f:concept"
},
{
"name": "description",
"type": "string",
"documentation": "Text search in the description of the concept map",
"xpath": "f:ConceptMap/f:description"
},
{
"name": "identifier",
"type": "token",
"documentation": "The identifier of the concept map",
"xpath": "f:ConceptMap/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "Name of the concept map",
"xpath": "f:ConceptMap/f:name"
},
{
"name": "product",
"type": "token",
"documentation": "Reference to element/field/valueset provides the context",
"xpath": "f:ConceptMap/f:concept/f:map/f:product/f:concept"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the concept map",
"xpath": "f:ConceptMap/f:publisher"
},
{
"name": "source",
"type": "reference",
"documentation": "The system for any concepts mapped by this concept map",
"xpath": "f:ConceptMap/f:source"
},
{
"name": "status",
"type": "token",
"documentation": "Status of the concept map",
"xpath": "f:ConceptMap/f:status"
},
{
"name": "system",
"type": "token",
"documentation": "The system for any destination concepts mapped by this map",
"xpath": "f:ConceptMap/f:concept/f:map/f:system"
},
{
"name": "target",
"type": "reference",
"documentation": "Provides context to the mappings",
"xpath": "f:ConceptMap/f:target"
},
{
"name": "version",
"type": "token",
"documentation": "The version identifier of the concept map",
"xpath": "f:ConceptMap/f:version"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change