FHIR Release 3 (STU)
TerminologyThis page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
| Vocabulary Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for conceptmap
{
"resourceType": "StructureDefinition",
"id": "ConceptMap",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 3
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "vocab"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/ConceptMap",
"name": "ConceptMap",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (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",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "ConceptMap",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "ConceptMap",
"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": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "conformance.terminology"
}
]
},
{
"id": "ConceptMap.id",
"path": "ConceptMap.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ConceptMap.meta",
"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",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ConceptMap.implicitRules",
"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.",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ConceptMap.language",
"path": "ConceptMap.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ConceptMap.text",
"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.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ConceptMap.contained",
"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.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.extension",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.modifierExtension",
"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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.url",
"path": "ConceptMap.url",
"short": "Logical URI to reference this concept map (globally unique)",
"definition": "An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.",
"requirements": "Allows the concept map to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ConceptMap.identifier",
"path": "ConceptMap.identifier",
"short": "Additional identifier for the concept map",
"definition": "A 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.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this concept map outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ConceptMap.version",
"path": "ConceptMap.version",
"short": "Business 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 concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the concept map with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "ConceptMap.name",
"path": "ConceptMap.name",
"short": "Name for this concept map (computer friendly)",
"definition": "A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ConceptMap.title",
"path": "ConceptMap.title",
"short": "Name for this concept map (human friendly)",
"definition": "A short, descriptive, user-friendly title for the concept map.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ConceptMap.status",
"path": "ConceptMap.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this concept map. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of concept maps that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired concept map without due consideration.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ConceptMap.experimental",
"path": "ConceptMap.experimental",
"short": "For testing purposes, not real usage",
"definition": "A boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment": "Allows filtering of concept map that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental concept map in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "ConceptMap.date",
"path": "ConceptMap.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the concept map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.",
"comment": "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. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "ConceptMap.publisher",
"path": "ConceptMap.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the concept map.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the concept map. 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,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "ConceptMap.contact",
"path": "ConceptMap.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "ConceptMap.description",
"path": "ConceptMap.description",
"short": "Natural language description of the concept map",
"definition": "A free text natural language description of the concept map from a consumer's perspective.",
"comment": "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": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.useContext",
"path": "ConceptMap.useContext",
"short": "Context the content is intended to support",
"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 for appropriate concept map instances.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "ConceptMap.jurisdiction",
"path": "ConceptMap.jurisdiction",
"short": "Intended jurisdiction for concept map (if applicable)",
"definition": "A legal or geographic region in which the concept map is intended to be used.",
"comment": "It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "ConceptMap.purpose",
"path": "ConceptMap.purpose",
"short": "Why this concept map is defined",
"definition": "Explaination of why this concept map is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the concept map Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ConceptMap.copyright",
"path": "ConceptMap.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.",
"comment": "null Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ConceptMap.source[x]",
"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.",
"comment": "Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"isSummary": true
},
{
"id": "ConceptMap.target[x]",
"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.",
"comment": "Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"isSummary": true
},
{
"id": "ConceptMap.group",
"path": "ConceptMap.group",
"short": "Same source and target systems",
"definition": "A group of mappings that all have the same source and target system.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "ConceptMap.group.id",
"path": "ConceptMap.group.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.extension",
"path": "ConceptMap.group.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.modifierExtension",
"path": "ConceptMap.group.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.group.source",
"path": "ConceptMap.group.source",
"short": "Code System (if value set crosses code systems)",
"definition": "An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "ConceptMap.group.sourceVersion",
"path": "ConceptMap.group.sourceVersion",
"short": "Specific version of the code system",
"definition": "The specific version of the code system, as determined by the code system authority.",
"comment": "The specification of a particular code system version may be required for code systems which lack concept permanence.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.target",
"path": "ConceptMap.group.target",
"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).",
"comment": "Target may be omitted if all the targget element equivalence values are 'unmatched'.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "ConceptMap.group.targetVersion",
"path": "ConceptMap.group.targetVersion",
"short": "Specific version of the code system",
"definition": "The specific version of the code system, as determined by the code system authority.",
"comment": "The specification of a particular code system version may be required for code systems which lack concept permanence.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SourceElement"
}
],
"path": "ConceptMap.group.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.",
"comment": "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 multiple times with different comments or dependencies.",
"alias": [
"code",
"concept",
"item"
],
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "ConceptMap.group.element.id",
"path": "ConceptMap.group.element.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.element.extension",
"path": "ConceptMap.group.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.element.modifierExtension",
"path": "ConceptMap.group.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.group.element.code",
"path": "ConceptMap.group.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"
}
]
},
{
"id": "ConceptMap.group.element.display",
"path": "ConceptMap.group.element.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "TargetElement"
}
],
"path": "ConceptMap.group.element.target",
"short": "Concept in target system for element",
"definition": "A concept from the target value set that this concept maps to.",
"comment": "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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "cmd-1",
"severity": "error",
"human": "If the map is narrower or inexact, there SHALL be some comments",
"expression": "comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))",
"xpath": "exists(f:comment) or not(exists(f:equivalence)) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
]
},
{
"id": "ConceptMap.group.element.target.id",
"path": "ConceptMap.group.element.target.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.element.target.extension",
"path": "ConceptMap.group.element.target.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.element.target.modifierExtension",
"path": "ConceptMap.group.element.target.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.group.element.target.code",
"path": "ConceptMap.group.element.target.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"
}
]
},
{
"id": "ConceptMap.group.element.target.display",
"path": "ConceptMap.group.element.target.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target.equivalence",
"path": "ConceptMap.group.element.target.equivalence",
"short": "relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint",
"definition": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).",
"comment": "This element is labeled as a modifier because it may indicate that a target does not apply.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"defaultValueCode": "equivalent",
"isModifier": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptMapEquivalence"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The degree of equivalence between concepts.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/concept-map-equivalence"
}
}
},
{
"id": "ConceptMap.group.element.target.comment",
"path": "ConceptMap.group.element.target.comment",
"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"
]
},
{
"id": "ConceptMap.group.element.target.dependsOn",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "OtherElement"
}
],
"path": "ConceptMap.group.element.target.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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.id",
"path": "ConceptMap.group.element.target.dependsOn.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.extension",
"path": "ConceptMap.group.element.target.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.modifierExtension",
"path": "ConceptMap.group.element.target.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.property",
"path": "ConceptMap.group.element.target.dependsOn.property",
"short": "Reference to property mapping depends on",
"definition": "A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labeled to correspond with a code system property.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.system",
"path": "ConceptMap.group.element.target.dependsOn.system",
"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 crosses code systems).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"meaningWhenMissing": "The code is in the source (dependsOn) or target (product) system"
},
{
"id": "ConceptMap.group.element.target.dependsOn.code",
"path": "ConceptMap.group.element.target.dependsOn.code",
"short": "Value of the referenced element",
"definition": "Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.display",
"path": "ConceptMap.group.element.target.dependsOn.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target.product",
"path": "ConceptMap.group.element.target.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": "*",
"contentReference": "#ConceptMap.group.element.target.dependsOn"
},
{
"id": "ConceptMap.group.unmapped",
"path": "ConceptMap.group.unmapped",
"short": "When no match in the mappings",
"definition": "What to do when there is no match in the mappings in the group.",
"comment": "This only applies if the source code is in the system defined for the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "cmd-3",
"severity": "error",
"human": "If the mode is 'other-map', a code must be provided",
"expression": "(mode = 'other-map') implies url.exists()",
"xpath": "(f:mode/@value != 'other-map') or exists(f:url)"
},
{
"key": "cmd-2",
"severity": "error",
"human": "If the mode is 'fixed', a code must be provided",
"expression": "(mode = 'fixed') implies code.exists()",
"xpath": "(f:mode/@value != 'fixed') or exists(f:code)"
}
]
},
{
"id": "ConceptMap.group.unmapped.id",
"path": "ConceptMap.group.unmapped.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.unmapped.extension",
"path": "ConceptMap.group.unmapped.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ConceptMap.group.unmapped.modifierExtension",
"path": "ConceptMap.group.unmapped.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.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.group.unmapped.mode",
"path": "ConceptMap.group.unmapped.mode",
"short": "provided | fixed | other-map",
"definition": "Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptMapGroupUnmappedMode"
}
],
"strength": "required",
"description": "Defines which action to take if there is no match in the group.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode"
}
}
},
{
"id": "ConceptMap.group.unmapped.code",
"path": "ConceptMap.group.unmapped.code",
"short": "Fixed code when mode = fixed",
"definition": "The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "ConceptMap.group.unmapped.display",
"path": "ConceptMap.group.unmapped.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.unmapped.url",
"path": "ConceptMap.group.unmapped.url",
"short": "Canonical URL for other concept map",
"definition": "The canonical URL of the map to use if this map contains no mapping.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ConceptMap",
"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": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "conformance.terminology"
}
]
},
{
"id": "ConceptMap.url",
"path": "ConceptMap.url",
"short": "Logical URI to reference this concept map (globally unique)",
"definition": "An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.",
"requirements": "Allows the concept map to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ConceptMap.identifier",
"path": "ConceptMap.identifier",
"short": "Additional identifier for the concept map",
"definition": "A 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.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this concept map outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ConceptMap.version",
"path": "ConceptMap.version",
"short": "Business 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 concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the concept map with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "ConceptMap.name",
"path": "ConceptMap.name",
"short": "Name for this concept map (computer friendly)",
"definition": "A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ConceptMap.title",
"path": "ConceptMap.title",
"short": "Name for this concept map (human friendly)",
"definition": "A short, descriptive, user-friendly title for the concept map.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ConceptMap.status",
"path": "ConceptMap.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this concept map. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of concept maps that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired concept map without due consideration.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "ConceptMap.experimental",
"path": "ConceptMap.experimental",
"short": "For testing purposes, not real usage",
"definition": "A boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment": "Allows filtering of concept map that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental concept map in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "ConceptMap.date",
"path": "ConceptMap.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the concept map was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.",
"comment": "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. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "ConceptMap.publisher",
"path": "ConceptMap.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the concept map.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the concept map. 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,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "ConceptMap.contact",
"path": "ConceptMap.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "ConceptMap.description",
"path": "ConceptMap.description",
"short": "Natural language description of the concept map",
"definition": "A free text natural language description of the concept map from a consumer's perspective.",
"comment": "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": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.useContext",
"path": "ConceptMap.useContext",
"short": "Context the content is intended to support",
"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 for appropriate concept map instances.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "ConceptMap.jurisdiction",
"path": "ConceptMap.jurisdiction",
"short": "Intended jurisdiction for concept map (if applicable)",
"definition": "A legal or geographic region in which the concept map is intended to be used.",
"comment": "It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "ConceptMap.purpose",
"path": "ConceptMap.purpose",
"short": "Why this concept map is defined",
"definition": "Explaination of why this concept map is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the concept map Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ConceptMap.copyright",
"path": "ConceptMap.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.",
"comment": "null Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ConceptMap.source[x]",
"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.",
"comment": "Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"isSummary": true
},
{
"id": "ConceptMap.target[x]",
"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.",
"comment": "Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ValueSet"
}
],
"isSummary": true
},
{
"id": "ConceptMap.group",
"path": "ConceptMap.group",
"short": "Same source and target systems",
"definition": "A group of mappings that all have the same source and target system.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ConceptMap.group.source",
"path": "ConceptMap.group.source",
"short": "Code System (if value set crosses code systems)",
"definition": "An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "ConceptMap.group.sourceVersion",
"path": "ConceptMap.group.sourceVersion",
"short": "Specific version of the code system",
"definition": "The specific version of the code system, as determined by the code system authority.",
"comment": "The specification of a particular code system version may be required for code systems which lack concept permanence.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.target",
"path": "ConceptMap.group.target",
"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).",
"comment": "Target may be omitted if all the targget element equivalence values are 'unmatched'.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "ConceptMap.group.targetVersion",
"path": "ConceptMap.group.targetVersion",
"short": "Specific version of the code system",
"definition": "The specific version of the code system, as determined by the code system authority.",
"comment": "The specification of a particular code system version may be required for code systems which lack concept permanence.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "SourceElement"
}
],
"path": "ConceptMap.group.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.",
"comment": "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 multiple times with different comments or dependencies.",
"alias": [
"code",
"concept",
"item"
],
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ConceptMap.group.element.code",
"path": "ConceptMap.group.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"
}
]
},
{
"id": "ConceptMap.group.element.display",
"path": "ConceptMap.group.element.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "TargetElement"
}
],
"path": "ConceptMap.group.element.target",
"short": "Concept in target system for element",
"definition": "A concept from the target value set that this concept maps to.",
"comment": "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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "cmd-1",
"severity": "error",
"human": "If the map is narrower or inexact, there SHALL be some comments",
"expression": "comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))",
"xpath": "exists(f:comment) or not(exists(f:equivalence)) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))"
}
]
},
{
"id": "ConceptMap.group.element.target.code",
"path": "ConceptMap.group.element.target.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"
}
]
},
{
"id": "ConceptMap.group.element.target.display",
"path": "ConceptMap.group.element.target.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target.equivalence",
"path": "ConceptMap.group.element.target.equivalence",
"short": "relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint",
"definition": "The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).",
"comment": "This element is labeled as a modifier because it may indicate that a target does not apply.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"defaultValueCode": "equivalent",
"isModifier": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptMapEquivalence"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The degree of equivalence between concepts.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/concept-map-equivalence"
}
}
},
{
"id": "ConceptMap.group.element.target.comment",
"path": "ConceptMap.group.element.target.comment",
"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"
]
},
{
"id": "ConceptMap.group.element.target.dependsOn",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "OtherElement"
}
],
"path": "ConceptMap.group.element.target.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": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.property",
"path": "ConceptMap.group.element.target.dependsOn.property",
"short": "Reference to property mapping depends on",
"definition": "A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labeled to correspond with a code system property.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.system",
"path": "ConceptMap.group.element.target.dependsOn.system",
"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 crosses code systems).",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"meaningWhenMissing": "The code is in the source (dependsOn) or target (product) system"
},
{
"id": "ConceptMap.group.element.target.dependsOn.code",
"path": "ConceptMap.group.element.target.dependsOn.code",
"short": "Value of the referenced element",
"definition": "Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target.dependsOn.display",
"path": "ConceptMap.group.element.target.dependsOn.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target.product",
"path": "ConceptMap.group.element.target.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": "*",
"contentReference": "#ConceptMap.group.element.target.dependsOn"
},
{
"id": "ConceptMap.group.unmapped",
"path": "ConceptMap.group.unmapped",
"short": "When no match in the mappings",
"definition": "What to do when there is no match in the mappings in the group.",
"comment": "This only applies if the source code is in the system defined for the group.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "cmd-3",
"severity": "error",
"human": "If the mode is 'other-map', a code must be provided",
"expression": "(mode = 'other-map') implies url.exists()",
"xpath": "(f:mode/@value != 'other-map') or exists(f:url)"
},
{
"key": "cmd-2",
"severity": "error",
"human": "If the mode is 'fixed', a code must be provided",
"expression": "(mode = 'fixed') implies code.exists()",
"xpath": "(f:mode/@value != 'fixed') or exists(f:code)"
}
]
},
{
"id": "ConceptMap.group.unmapped.mode",
"path": "ConceptMap.group.unmapped.mode",
"short": "provided | fixed | other-map",
"definition": "Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptMapGroupUnmappedMode"
}
],
"strength": "required",
"description": "Defines which action to take if there is no match in the group.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode"
}
}
},
{
"id": "ConceptMap.group.unmapped.code",
"path": "ConceptMap.group.unmapped.code",
"short": "Fixed code when mode = fixed",
"definition": "The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "ConceptMap.group.unmapped.display",
"path": "ConceptMap.group.unmapped.display",
"short": "Display for the code",
"definition": "The display for the code. The display is only provided to help editors when editing the concept map.",
"comment": "The display is ignored when processing the map.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.unmapped.url",
"path": "ConceptMap.group.unmapped.url",
"short": "Canonical URL for other concept map",
"definition": "The canonical URL of the map to use if this map contains no mapping.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
}
]
}
}
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 Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change