Release 5
TerminologyThis page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Terminology Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
This is a representation of the json schema for ConceptMap, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/ConceptMap",
"$ref": "#/definitions/ConceptMap",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"ConceptMap": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"resourceType": {
"description": "This is a ConceptMap resource",
"const": "ConceptMap"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can 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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"url": {
"description": "An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.",
"$ref": "#/definitions/uri"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "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.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"version": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmString": {
"description": "Indicates the mechanism used to compare versions to determine which ConceptMap is more current.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_versionAlgorithmString": {
"description": "Extensions for versionAlgorithmString",
"$ref": "Element.schema.json#/definitions/Element"
},
"versionAlgorithmCoding": {
"description": "Indicates the mechanism used to compare versions to determine which ConceptMap is more current.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"name": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the concept map.",
"$ref": "#/definitions/string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this concept map. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "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.",
"$ref": "#/definitions/boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "The date (and optionally time) when the concept map was last significantly changed. The date must change 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.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual responsible for the release and ongoing maintenance of the concept map.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"description": {
"description": "A free text natural language description of the concept map from a consumer\u0027s perspective.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the concept map is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"purpose": {
"description": "Explanation of why this concept map is needed and why it has been designed as it has.",
"$ref": "#/definitions/markdown"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "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.",
"$ref": "#/definitions/markdown"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyrightLabel": {
"description": "A short string (\u003c50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. \u0027All rights reserved\u0027, \u0027Some rights reserved\u0027).",
"$ref": "#/definitions/string"
},
"_copyrightLabel": {
"description": "Extensions for copyrightLabel",
"$ref": "Element.schema.json#/definitions/Element"
},
"approvalDate": {
"description": "The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.",
"$ref": "#/definitions/date"
},
"_approvalDate": {
"description": "Extensions for approvalDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"lastReviewDate": {
"description": "The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.",
"$ref": "#/definitions/date"
},
"_lastReviewDate": {
"description": "Extensions for lastReviewDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"effectivePeriod": {
"description": "The period during which the ConceptMap content was or is planned to be in active use.",
"$ref": "Period.schema.json#/definitions/Period"
},
"topic": {
"description": "Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"author": {
"description": "An individiual or organization primarily involved in the creation and maintenance of the ConceptMap.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"editor": {
"description": "An individual or organization primarily responsible for internal coherence of the ConceptMap.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"reviewer": {
"description": "An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"endorser": {
"description": "An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"relatedArtifact": {
"description": "Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.",
"items": {
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"type": "array"
},
"property": {
"description": "A property defines a slot through which additional information can be provided about a map from source -\u003e target.",
"items": {
"$ref": "#/definitions/ConceptMap_Property"
},
"type": "array"
},
"additionalAttribute": {
"description": "An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).",
"items": {
"$ref": "#/definitions/ConceptMap_AdditionalAttribute"
},
"type": "array"
},
"sourceScopeUri": {
"description": "Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set.",
"pattern": "^\\S*$",
"type": "string"
},
"_sourceScopeUri": {
"description": "Extensions for sourceScopeUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"sourceScopeCanonical": {
"description": "Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set.",
"pattern": "^\\S*$",
"type": "string"
},
"_sourceScopeCanonical": {
"description": "Extensions for sourceScopeCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"targetScopeUri": {
"description": "Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set.",
"pattern": "^\\S*$",
"type": "string"
},
"_targetScopeUri": {
"description": "Extensions for targetScopeUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"targetScopeCanonical": {
"description": "Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set.",
"pattern": "^\\S*$",
"type": "string"
},
"_targetScopeCanonical": {
"description": "Extensions for targetScopeCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"group": {
"description": "A group of mappings that all have the same source and target system.",
"items": {
"$ref": "#/definitions/ConceptMap_Group"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"ConceptMap_Property": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"uri": {
"description": "Reference to the formal meaning of the property.",
"$ref": "#/definitions/uri"
},
"_uri": {
"description": "Extensions for uri",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A description of the property - why it is defined, and how its value might be used.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The type of the property value.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"system": {
"description": "The CodeSystem that defines the codes from which values of type ```code``` in property values.",
"$ref": "canonical.schema.json#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false
},
"ConceptMap_AdditionalAttribute": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"uri": {
"description": "Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.",
"$ref": "#/definitions/uri"
},
"_uri": {
"description": "Extensions for uri",
"$ref": "Element.schema.json#/definitions/Element"
},
"description": {
"description": "A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "The type of the source data contained in this concept map for this data element.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ConceptMap_Group": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"source": {
"description": "An absolute URI that identifies the source system where the concepts to be mapped are defined.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"target": {
"description": "An absolute URI that identifies the target system that the concepts will be mapped to.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"element": {
"description": "Mappings for an individual concept in the source to one or more concepts in the target.",
"items": {
"$ref": "#/definitions/ConceptMap_Element"
},
"type": "array"
},
"unmapped": {
"description": "What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the \"default\" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.",
"$ref": "#/definitions/ConceptMap_Unmapped"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"element"
]
},
"ConceptMap_Element": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "Identity (code or path) or the element/item being mapped.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"display": {
"description": "The display for the code. The display is only provided to help editors when editing the concept map.",
"$ref": "#/definitions/string"
},
"_display": {
"description": "Extensions for display",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueSet": {
"description": "The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"noMap": {
"description": "If noMap \u003d true this indicates that no mapping to a target concept exists for this source concept.",
"$ref": "#/definitions/boolean"
},
"_noMap": {
"description": "Extensions for noMap",
"$ref": "Element.schema.json#/definitions/Element"
},
"target": {
"description": "A concept from the target value set that this concept maps to.",
"items": {
"$ref": "#/definitions/ConceptMap_Target"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ConceptMap_Target": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "Identity (code or path) or the element/item that the map refers to.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"display": {
"description": "The display for the code. The display is only provided to help editors when editing the concept map.",
"$ref": "#/definitions/string"
},
"_display": {
"description": "Extensions for display",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueSet": {
"description": "The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"relationship": {
"description": "The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).",
"$ref": "#/definitions/code"
},
"_relationship": {
"description": "Extensions for relationship",
"$ref": "Element.schema.json#/definitions/Element"
},
"comment": {
"description": "A description of status/issues in mapping that conveys additional information not represented in the structured data.",
"$ref": "#/definitions/string"
},
"_comment": {
"description": "Extensions for comment",
"$ref": "Element.schema.json#/definitions/Element"
},
"property": {
"description": "A property value for this source -\u003e target mapping.",
"items": {
"$ref": "#/definitions/ConceptMap_Property1"
},
"type": "array"
},
"dependsOn": {
"description": "A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified data attribute can be resolved, and it has the specified value.",
"items": {
"$ref": "#/definitions/ConceptMap_DependsOn"
},
"type": "array"
},
"product": {
"description": "Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.",
"items": {
"$ref": "#/definitions/ConceptMap_DependsOn"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"ConceptMap_Property1": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"code": {
"description": "A reference to a mapping property defined in ConceptMap.property.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCoding": {
"description": "The value of this property. If the type chosen for this element is \u0027code\u0027, then the property SHALL be defined in a ConceptMap.property element.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"valueString": {
"description": "The value of this property. If the type chosen for this element is \u0027code\u0027, then the property SHALL be defined in a ConceptMap.property element.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInteger": {
"description": "The value of this property. If the type chosen for this element is \u0027code\u0027, then the property SHALL be defined in a ConceptMap.property element.",
"pattern": "^[0]|[-+]?[1-9][0-9]*$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "The value of this property. If the type chosen for this element is \u0027code\u0027, then the property SHALL be defined in a ConceptMap.property element.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDateTime": {
"description": "The value of this property. If the type chosen for this element is \u0027code\u0027, then the property SHALL be defined in a ConceptMap.property element.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]{1,9})?)?)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDecimal": {
"description": "The value of this property. If the type chosen for this element is \u0027code\u0027, then the property SHALL be defined in a ConceptMap.property element.",
"pattern": "^-?(0|[1-9][0-9]{0,17})(\\.[0-9]{1,17})?([eE][+-]?[0-9]{1,9}})?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCode": {
"description": "The value of this property. If the type chosen for this element is \u0027code\u0027, then the property SHALL be defined in a ConceptMap.property element.",
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string"
},
"_valueCode": {
"description": "Extensions for valueCode",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"type": "object",
"additionalProperties": false
},
"ConceptMap_DependsOn": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"attribute": {
"description": "A reference to the additional attribute that holds a value the map depends on.",
"$ref": "#/definitions/code"
},
"_attribute": {
"description": "Extensions for attribute",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCode": {
"description": "Data element value that the map depends on / produces.",
"pattern": "^[^\\s]+( [^\\s]+)*$",
"type": "string"
},
"_valueCode": {
"description": "Extensions for valueCode",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCoding": {
"description": "Data element value that the map depends on / produces.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"valueString": {
"description": "Data element value that the map depends on / produces.",
"pattern": "^^[\\s\\S]+$$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "Data element value that the map depends on / produces.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueQuantity": {
"description": "Data element value that the map depends on / produces.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueSet": {
"description": "This mapping applies if the data element value is a code from this value set.",
"$ref": "canonical.schema.json#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false
},
"ConceptMap_Unmapped": {
"description": "A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"mode": {
"description": "Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped source 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).",
"$ref": "#/definitions/code"
},
"_mode": {
"description": "Extensions for mode",
"$ref": "Element.schema.json#/definitions/Element"
},
"code": {
"description": "The fixed code to use when the mode \u003d \u0027fixed\u0027 - all unmapped codes are mapped to a single fixed code.",
"$ref": "#/definitions/code"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"display": {
"description": "The display for the code. The display is only provided to help editors when editing the concept map.",
"$ref": "#/definitions/string"
},
"_display": {
"description": "Extensions for display",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueSet": {
"description": "The set of fixed codes to use when the mode \u003d \u0027fixed\u0027 - all unmapped codes are mapped to each of the fixed codes.",
"$ref": "canonical.schema.json#/definitions/canonical"
},
"relationship": {
"description": "The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is \u0027fixed\u0027 or \u0027use-source-code\u0027.",
"$ref": "#/definitions/code"
},
"_relationship": {
"description": "Extensions for relationship",
"$ref": "Element.schema.json#/definitions/Element"
},
"otherMap": {
"description": "The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.",
"$ref": "canonical.schema.json#/definitions/canonical"
}
},
"type": "object",
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R5 hl7.fhir.core#5.0.0 generated on Sun, Mar 26, 2023 15:24+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4 |
Compare to R4B |
|
Propose a change