FHIR IG analytics| Package | hl7.fhir.uv.xver-r4b.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-ConceptMap.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-ConceptMap
FHIR
FHIRsmith
{
"resourceType": "StructureDefinition",
"id": "profile-ConceptMap",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4b.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.3/StructureDefinition/profile-ConceptMap",
"version": "0.1.0",
"name": "Profile_R4B_ConceptMap_R3",
"title": "Cross-version Profile for R4B.ConceptMap for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:24.9150425-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4B ConceptMap content to be represented via FHIR STU3 ConceptMap resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"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/ConceptMap",
"derivation": "constraint",
"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": "*",
"base": {
"path": "ConceptMap",
"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": "http://hl7.org/fhir/StructureDefinition/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": "http://hl7.org/fhir/StructureDefinition/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": "http://hl7.org/fhir/StructureDefinition/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": "http://hl7.org/fhir/StructureDefinition/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.meta.id",
"path": "ConceptMap.meta.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.meta.extension",
"path": "ConceptMap.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "ConceptMap.meta.extension:meta",
"path": "ConceptMap.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `ConceptMap.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `ConceptMap.meta` is mapped to FHIR STU3 element `ConceptMap.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.meta` do not cover the following types: Meta.\nThe mappings for `ConceptMap.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.meta|0.1.0"
}
]
},
{
"id": "ConceptMap.meta.versionId",
"path": "ConceptMap.meta.versionId",
"short": "Version specific identifier",
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ConceptMap.meta.lastUpdated",
"path": "ConceptMap.meta.lastUpdated",
"short": "When the resource version last changed",
"definition": "When the resource last changed - e.g. when the version changed.",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true
},
{
"id": "ConceptMap.meta.profile",
"path": "ConceptMap.meta.profile",
"short": "Profiles this resource claims to conform to",
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/STU3/).",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "ConceptMap.meta.security",
"path": "ConceptMap.meta.security",
"short": "Security Labels applied to this resource",
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels|3.0.2"
}
}
},
{
"id": "ConceptMap.meta.tag",
"path": "ConceptMap.meta.tag",
"short": "Tags applied to this resource",
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
}
],
"strength": "example",
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags|3.0.2"
}
}
},
{
"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|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"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.text.id",
"path": "ConceptMap.text.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.text.extension",
"path": "ConceptMap.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "ConceptMap.text.extension:text",
"path": "ConceptMap.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `ConceptMap.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `ConceptMap.text` is mapped to FHIR STU3 element `ConceptMap.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.text` do not cover the following types: Narrative.\nThe mappings for `ConceptMap.text` do not cover the following types based on type expansion: div, status.\nContained 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 information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.text|0.1.0"
}
]
},
{
"id": "ConceptMap.text.status",
"path": "ConceptMap.text.status",
"short": "generated | extensions | additional | empty",
"definition": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
}
],
"strength": "required",
"description": "The status of a resource narrative",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/narrative-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ConceptMap.text.div",
"path": "ConceptMap.text.div",
"short": "Limited xhtml content",
"definition": "The actual narrative content, a stripped down version of XHTML.",
"comment": "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.div",
"min": 1,
"max": "1"
},
"type": [
{
"code": "xhtml"
}
],
"constraint": [
{
"key": "txt-1",
"severity": "error",
"human": "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes",
"expression": "htmlchecks()",
"xpath": "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])",
"source": "http://hl7.org/fhir/StructureDefinition/ConceptMap"
},
{
"key": "txt-2",
"severity": "error",
"human": "The narrative SHALL have some non-whitespace content",
"expression": "htmlchecks()",
"xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]",
"source": "http://hl7.org/fhir/StructureDefinition/ConceptMap"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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](http://hl7.org/fhir/STU3/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",
"base": {
"path": "ConceptMap.url",
"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",
"base": {
"path": "ConceptMap.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ConceptMap.identifier.id",
"path": "ConceptMap.identifier.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.identifier.extension",
"path": "ConceptMap.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "ConceptMap.identifier.extension:identifier",
"path": "ConceptMap.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `ConceptMap.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `ConceptMap.identifier` is mapped to FHIR STU3 element `ConceptMap.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.identifier` do not cover the following types: Identifier.\nThe mappings for `ConceptMap.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.\nTypically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.identifier|0.1.0"
}
]
},
{
"id": "ConceptMap.identifier.use",
"path": "ConceptMap.identifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "ConceptMap.identifier.type",
"path": "ConceptMap.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "ConceptMap.identifier.system",
"path": "ConceptMap.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "ConceptMap.identifier.value",
"path": "ConceptMap.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/STU3/extension-rendered-value.html).",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "ConceptMap.identifier.period",
"path": "ConceptMap.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "ConceptMap.identifier.assigner",
"path": "ConceptMap.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"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",
"base": {
"path": "ConceptMap.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",
"base": {
"path": "ConceptMap.name",
"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",
"base": {
"path": "ConceptMap.title",
"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",
"base": {
"path": "ConceptMap.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status|3.0.2"
}
},
"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",
"base": {
"path": "ConceptMap.experimental",
"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",
"base": {
"path": "ConceptMap.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",
"base": {
"path": "ConceptMap.publisher",
"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": "*",
"base": {
"path": "ConceptMap.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "ConceptMap.contact.id",
"path": "ConceptMap.contact.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). 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.contact.extension",
"path": "ConceptMap.contact.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "ConceptMap.contact.extension:contact",
"path": "ConceptMap.contact.extension",
"sliceName": "contact",
"short": "R4B: contact additional types",
"definition": "R4B: `ConceptMap.contact` additional types (ContactDetail) additional types from child elements (name, telecom)",
"comment": "Element `ConceptMap.contact` is mapped to FHIR STU3 element `ConceptMap.contact` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.contact` do not cover the following types: ContactDetail.\nThe mappings for `ConceptMap.contact` do not cover the following types based on type expansion: name, telecom.\nMay be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.contact|0.1.0"
}
]
},
{
"id": "ConceptMap.contact.name",
"path": "ConceptMap.contact.name",
"short": "Name of an individual to contact",
"definition": "The name of an individual to contact.",
"comment": "If there is no named individual, the telecom information is for the organization as a whole.",
"min": 0,
"max": "1",
"base": {
"path": "ContactDetail.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ConceptMap.contact.telecom",
"path": "ConceptMap.contact.telecom",
"short": "Contact details for individual or organization",
"definition": "The contact details for the individual (if a name was provided) or the organization.",
"min": 0,
"max": "*",
"base": {
"path": "ContactDetail.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint"
}
],
"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",
"base": {
"path": "ConceptMap.description",
"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": "*",
"base": {
"path": "ConceptMap.useContext",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "ConceptMap.useContext.id",
"path": "ConceptMap.useContext.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.useContext.extension",
"path": "ConceptMap.useContext.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "ConceptMap.useContext.extension:useContext",
"path": "ConceptMap.useContext.extension",
"sliceName": "useContext",
"short": "R4B: The context that the content is intended to support additional types",
"definition": "R4B: `ConceptMap.useContext` additional types (UsageContext) additional types from child elements (code, value[x])",
"comment": "Element `ConceptMap.useContext` is mapped to FHIR STU3 element `ConceptMap.useContext` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.useContext` do not cover the following types: UsageContext.\nThe mappings for `ConceptMap.useContext` do not cover the following types based on type expansion: code, value[x].\nWhen multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.useContext|0.1.0"
}
]
},
{
"id": "ConceptMap.useContext.code",
"path": "ConceptMap.useContext.code",
"short": "Type of context being specified",
"definition": "A code that identifies the type of context being specified by this usage context.",
"min": 1,
"max": "1",
"base": {
"path": "UsageContext.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UsageContextType"
}
],
"strength": "extensible",
"description": "A code that specifies a type of context being specified by a usage context",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/usage-context-type|3.0.2"
}
}
},
{
"id": "ConceptMap.useContext.value[x]",
"path": "ConceptMap.useContext.value[x]",
"short": "Value that defines the context",
"definition": "A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.",
"min": 1,
"max": "1",
"base": {
"path": "UsageContext.value[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "UsageContextValue"
}
],
"strength": "example",
"description": "A code that defines the specific value for the context being specified",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/use-context|3.0.2"
}
}
},
{
"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": "*",
"base": {
"path": "ConceptMap.jurisdiction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction|3.0.2"
}
}
},
{
"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",
"base": {
"path": "ConceptMap.purpose",
"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",
"base": {
"path": "ConceptMap.copyright",
"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",
"base": {
"path": "ConceptMap.source[x]",
"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",
"base": {
"path": "ConceptMap.target[x]",
"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": "*",
"base": {
"path": "ConceptMap.group",
"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": "http://hl7.org/fhir/StructureDefinition/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",
"base": {
"path": "ConceptMap.group.source",
"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",
"base": {
"path": "ConceptMap.group.sourceVersion",
"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",
"base": {
"path": "ConceptMap.group.target",
"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",
"base": {
"path": "ConceptMap.group.targetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element",
"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": "*",
"base": {
"path": "ConceptMap.group.element",
"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": "http://hl7.org/fhir/StructureDefinition/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",
"base": {
"path": "ConceptMap.group.element.code",
"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",
"base": {
"path": "ConceptMap.group.element.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ConceptMap.group.element.target",
"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": "*",
"base": {
"path": "ConceptMap.group.element.target",
"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": "http://hl7.org/fhir/StructureDefinition/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'))",
"source": "http://hl7.org/fhir/StructureDefinition/ConceptMap"
}
]
},
{
"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",
"base": {
"path": "ConceptMap.group.element.target.code",
"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",
"base": {
"path": "ConceptMap.group.element.target.display",
"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",
"base": {
"path": "ConceptMap.group.element.target.equivalence",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"defaultValueCode": "equivalent",
"isModifier": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptMapEquivalence"
}
],
"strength": "required",
"description": "The degree of equivalence between concepts.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/concept-map-equivalence|3.0.2"
}
}
},
{
"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",
"base": {
"path": "ConceptMap.group.element.target.comment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"cmd-1"
]
},
{
"id": "ConceptMap.group.element.target.dependsOn",
"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": "*",
"base": {
"path": "ConceptMap.group.element.target.dependsOn",
"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": "http://hl7.org/fhir/StructureDefinition/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",
"base": {
"path": "ConceptMap.group.element.target.dependsOn.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",
"base": {
"path": "ConceptMap.group.element.target.dependsOn.system",
"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",
"base": {
"path": "ConceptMap.group.element.target.dependsOn.code",
"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",
"base": {
"path": "ConceptMap.group.element.target.dependsOn.display",
"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": "*",
"base": {
"path": "ConceptMap.group.element.target.product",
"min": 0,
"max": "*"
},
"contentReference": "http://hl7.org/fhir/StructureDefinition/ConceptMap#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",
"base": {
"path": "ConceptMap.group.unmapped",
"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": "http://hl7.org/fhir/StructureDefinition/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)",
"source": "http://hl7.org/fhir/StructureDefinition/ConceptMap"
},
{
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/ConceptMap"
}
]
},
{
"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",
"base": {
"path": "ConceptMap.group.unmapped.mode",
"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|3.0.2"
}
}
},
{
"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",
"base": {
"path": "ConceptMap.group.unmapped.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",
"base": {
"path": "ConceptMap.group.unmapped.display",
"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",
"base": {
"path": "ConceptMap.group.unmapped.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
}
]
},
"differential": {
"element": [
{
"id": "ConceptMap",
"path": "ConceptMap"
},
{
"id": "ConceptMap.meta.extension",
"path": "ConceptMap.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "ConceptMap.meta.extension:meta",
"path": "ConceptMap.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `ConceptMap.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `ConceptMap.meta` is mapped to FHIR STU3 element `ConceptMap.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.meta` do not cover the following types: Meta.\nThe mappings for `ConceptMap.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.meta|0.1.0"
}
]
},
{
"id": "ConceptMap.text.extension",
"path": "ConceptMap.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "ConceptMap.text.extension:text",
"path": "ConceptMap.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `ConceptMap.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `ConceptMap.text` is mapped to FHIR STU3 element `ConceptMap.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.text` do not cover the following types: Narrative.\nThe mappings for `ConceptMap.text` do not cover the following types based on type expansion: div, status.\nContained 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 information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.text|0.1.0"
}
]
},
{
"id": "ConceptMap.identifier.extension",
"path": "ConceptMap.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "ConceptMap.identifier.extension:identifier",
"path": "ConceptMap.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `ConceptMap.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `ConceptMap.identifier` is mapped to FHIR STU3 element `ConceptMap.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.identifier` do not cover the following types: Identifier.\nThe mappings for `ConceptMap.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.\nTypically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.identifier|0.1.0"
}
]
},
{
"id": "ConceptMap.contact.extension",
"path": "ConceptMap.contact.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "ConceptMap.contact.extension:contact",
"path": "ConceptMap.contact.extension",
"sliceName": "contact",
"short": "R4B: contact additional types",
"definition": "R4B: `ConceptMap.contact` additional types (ContactDetail) additional types from child elements (name, telecom)",
"comment": "Element `ConceptMap.contact` is mapped to FHIR STU3 element `ConceptMap.contact` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.contact` do not cover the following types: ContactDetail.\nThe mappings for `ConceptMap.contact` do not cover the following types based on type expansion: name, telecom.\nMay be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.contact|0.1.0"
}
]
},
{
"id": "ConceptMap.useContext.extension",
"path": "ConceptMap.useContext.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "ConceptMap.useContext.extension:useContext",
"path": "ConceptMap.useContext.extension",
"sliceName": "useContext",
"short": "R4B: The context that the content is intended to support additional types",
"definition": "R4B: `ConceptMap.useContext` additional types (UsageContext) additional types from child elements (code, value[x])",
"comment": "Element `ConceptMap.useContext` is mapped to FHIR STU3 element `ConceptMap.useContext` as `SourceIsBroaderThanTarget`.\nThe mappings for `ConceptMap.useContext` do not cover the following types: UsageContext.\nThe mappings for `ConceptMap.useContext` do not cover the following types based on type expansion: code, value[x].\nWhen multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-ConceptMap.useContext|0.1.0"
}
]
}
]
}
}