This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Vocabulary Work Group | Maturity Level: 0 | Trial Use | Use Context: Any |
Definitions for the shareableconceptmap Profile.
ConceptMap | |||||||||||||||||||||||||||||
Element Id | ConceptMap | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | A map from one set of concepts to one or more other concepts | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.id | |||||||||||||||||||||||||||||
Element Id | ConceptMap.id | ||||||||||||||||||||||||||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||||||||||||||||||||||||
Short Display | Logical id of this artifact | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | id | ||||||||||||||||||||||||||||
Comments | Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case. | ||||||||||||||||||||||||||||
ConceptMap.meta | |||||||||||||||||||||||||||||
Element Id | ConceptMap.meta | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | Metadata about the resource | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | Meta | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.implicitRules | |||||||||||||||||||||||||||||
Element Id | ConceptMap.implicitRules | ||||||||||||||||||||||||||||
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||||||||||||||||||||||||
Short Display | A set of rules under which this content was created | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation) | ||||||||||||||||||||||||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.language | |||||||||||||||||||||||||||||
Element Id | ConceptMap.language | ||||||||||||||||||||||||||||
Definition | The base language in which the resource is written. | ||||||||||||||||||||||||||||
Short Display | Language of the resource content | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Terminology Binding | IETF language tag The codes SHOULD be taken from Common Languages | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. 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). | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.text | |||||||||||||||||||||||||||||
Element Id | ConceptMap.text | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | Text summary of the resource, for human interpretation | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | Narrative | ||||||||||||||||||||||||||||
Alternate Names | narrative, html, xhtml, display | ||||||||||||||||||||||||||||
Comments | Contained resources do not have a 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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.contained | |||||||||||||||||||||||||||||
Element Id | ConceptMap.contained | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | Contained, inline Resources | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Resource | ||||||||||||||||||||||||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||||||||||||||||||||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. | ||||||||||||||||||||||||||||
ConceptMap.extension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.extension | ||||||||||||||||||||||||||||
Definition | An Extension | ||||||||||||||||||||||||||||
Short Display | Extension | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
Slicing | This element introduces a set of slices. The slicing rules are:
| ||||||||||||||||||||||||||||
ConceptMap.extension(knowledgeRepresentationLevel) | |||||||||||||||||||||||||||||
Element Id | ConceptMap.extension:knowledgeRepresentationLevel | ||||||||||||||||||||||||||||
Definition | Defines a knowledge representation level provided by this knowledge artifact. | ||||||||||||||||||||||||||||
Short Display | narrative | semi-structured | structured | executable | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension(knowledgeRepresentationLevel) | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.modifierExtension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.modifierExtension | ||||||||||||||||||||||||||||
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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them) | ||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.url | |||||||||||||||||||||||||||||
Element Id | ConceptMap.url | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Requirements | Allows the concept map to be referenced by a single globally unique identifier. | ||||||||||||||||||||||||||||
Comments | 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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.identifier | |||||||||||||||||||||||||||||
Element Id | ConceptMap.identifier | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Additional identifier for the concept map | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||||||||||||||||||
Comments | Typically, 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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.version | |||||||||||||||||||||||||||||
Element Id | ConceptMap.version | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Business version of the concept map | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Comments | 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 reference to a particular business version of the concept map with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.name | |||||||||||||||||||||||||||||
Element Id | ConceptMap.name | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Name for this concept map (computer friendly) | ||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: cnl-0 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||||||||||||||
Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.title | |||||||||||||||||||||||||||||
Element Id | ConceptMap.title | ||||||||||||||||||||||||||||
Definition | A short, descriptive, user-friendly title for the concept map. | ||||||||||||||||||||||||||||
Short Display | Name for this concept map (human friendly) | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.status | |||||||||||||||||||||||||||||
Element Id | ConceptMap.status | ||||||||||||||||||||||||||||
Definition | The status of this concept map. Enables tracking the life-cycle of the content. | ||||||||||||||||||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Terminology Binding | The lifecycle status of an artifact. The codes SHALL be taken from PublicationStatus | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Comments | Allows filtering of concept maps that are appropriate for use versus not. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.experimental | |||||||||||||||||||||||||||||
Element Id | ConceptMap.experimental | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | For testing purposes, not real usage | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map. | ||||||||||||||||||||||||||||
Comments | Allows filtering of concept maps that are appropriate for use versus not. | ||||||||||||||||||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.date | |||||||||||||||||||||||||||||
Element Id | ConceptMap.date | ||||||||||||||||||||||||||||
Definition | The date (and optionally time) when the concept map was published. 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. | ||||||||||||||||||||||||||||
Short Display | Date last changed | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||||||||||||||
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.publisher | |||||||||||||||||||||||||||||
Element Id | ConceptMap.publisher | ||||||||||||||||||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the concept map. | ||||||||||||||||||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Requirements | Helps establish the "authority/credibility" of the concept map. May also allow for contact. | ||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.contact | |||||||||||||||||||||||||||||
Element Id | ConceptMap.contact | ||||||||||||||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||||||||||||||
Short Display | Contact details for the publisher | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.description | |||||||||||||||||||||||||||||
Element Id | ConceptMap.description | ||||||||||||||||||||||||||||
Definition | A free text natural language description of the concept map from a consumer's perspective. | ||||||||||||||||||||||||||||
Short Display | Natural language description of the concept map | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Must Support | true | ||||||||||||||||||||||||||||
Comments | The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.useContext | |||||||||||||||||||||||||||||
Element Id | ConceptMap.useContext | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | UsageContext | ||||||||||||||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.jurisdiction | |||||||||||||||||||||||||||||
Element Id | ConceptMap.jurisdiction | ||||||||||||||||||||||||||||
Definition | A legal or geographic region in which the concept map is intended to be used. | ||||||||||||||||||||||||||||
Short Display | Intended jurisdiction for concept map (if applicable) | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Terminology Binding | Countries and regions within which this artifact is targeted for use. The codes SHALL be taken from Jurisdiction; other codes may be used where these codes are not suitable | ||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||
Comments | It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.purpose | |||||||||||||||||||||||||||||
Element Id | ConceptMap.purpose | ||||||||||||||||||||||||||||
Definition | Explanation of why this concept map is needed and why it has been designed as it has. | ||||||||||||||||||||||||||||
Short Display | Why this concept map is defined | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.copyright | |||||||||||||||||||||||||||||
Element Id | ConceptMap.copyright | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content. | ||||||||||||||||||||||||||||
Alternate Names | License, Restrictions | ||||||||||||||||||||||||||||
Comments | Frequently the copyright differs between the concept map and codes that are included. The copyright statement should clearly differentiate between these when required. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.approvalDate | |||||||||||||||||||||||||||||
Element Id | ConceptMap.approvalDate | ||||||||||||||||||||||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||||||||||||||||||||||
Short Display | When the ConceptMap was approved by publisher | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.lastReviewDate | |||||||||||||||||||||||||||||
Element Id | ConceptMap.lastReviewDate | ||||||||||||||||||||||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||||||||||||||||||||||
Short Display | When the ConceptMap was last reviewed | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | date | ||||||||||||||||||||||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||||||||||||||||||||||
Comments | If specified, this date follows the original approval date. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.effectivePeriod | |||||||||||||||||||||||||||||
Element Id | ConceptMap.effectivePeriod | ||||||||||||||||||||||||||||
Definition | The period during which the ConceptMap content was or is planned to be in active use. | ||||||||||||||||||||||||||||
Short Display | When the ConceptMap is expected to be used | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | Period | ||||||||||||||||||||||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the ConceptMap are or are expected to be used instead. | ||||||||||||||||||||||||||||
Comments | The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.topic | |||||||||||||||||||||||||||||
Element Id | ConceptMap.topic | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | E.g. Education, Treatment, Assessment, etc. | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Terminology Binding | null For example codes, see DefinitionTopic | ||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||
Requirements | Repositories must be able to determine how to categorize the ConceptMap so that it can be found by topical and keyword searches. | ||||||||||||||||||||||||||||
Comments | This element provides topical categorization and keywords for the ConceptMap, as opposed to the more structured context-of-use information provided in the useContext element | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.author | |||||||||||||||||||||||||||||
Element Id | ConceptMap.author | ||||||||||||||||||||||||||||
Definition | An individiual or organization primarily involved in the creation and maintenance of the ConceptMap. | ||||||||||||||||||||||||||||
Short Display | Who authored the ConceptMap | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.editor | |||||||||||||||||||||||||||||
Element Id | ConceptMap.editor | ||||||||||||||||||||||||||||
Definition | An individual or organization primarily responsible for internal coherence of the ConceptMap. | ||||||||||||||||||||||||||||
Short Display | Who edited the ConceptMap | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.reviewer | |||||||||||||||||||||||||||||
Element Id | ConceptMap.reviewer | ||||||||||||||||||||||||||||
Definition | An individual or organization primarily responsible for review of some aspect of the ConceptMap. | ||||||||||||||||||||||||||||
Short Display | Who reviewed the ConceptMap | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.endorser | |||||||||||||||||||||||||||||
Element Id | ConceptMap.endorser | ||||||||||||||||||||||||||||
Definition | An individual or organization responsible for officially endorsing the ConceptMap for use in some setting. | ||||||||||||||||||||||||||||
Short Display | Who endorsed the ConceptMap | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.relatedArtifact | |||||||||||||||||||||||||||||
Element Id | ConceptMap.relatedArtifact | ||||||||||||||||||||||||||||
Definition | Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts. | ||||||||||||||||||||||||||||
Short Display | Additional documentation, citations, etc. | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | RelatedArtifact | ||||||||||||||||||||||||||||
Requirements | A ConceptMap must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content. | ||||||||||||||||||||||||||||
Comments | Each related artifact is either an attachment, or a reference to another resource, but not both. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.sourceScope[x] | |||||||||||||||||||||||||||||
Element Id | ConceptMap.sourceScope[x] | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | The source value set that contains the concepts that are being mapped | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | Choice of: uri, canonical(ValueSet) | ||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||
Comments | Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The sourceScope value set may select codes from either an explicit (standard or local) or implicit code system. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.targetScope[x] | |||||||||||||||||||||||||||||
Element Id | ConceptMap.targetScope[x] | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | The target value set which provides context for the mappings | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | Choice of: uri, canonical(ValueSet) | ||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||
Comments | Should be a version specific reference. URIs SHOULD be absolute. If there is no sourceScope or targetScope value set, there is no specified context for the map (not recommended). The targetScope value set may select codes from either an explicit (standard or local) or implicit code system. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group | ||||||||||||||||||||||||||||
Definition | A group of mappings that all have the same source and target system. | ||||||||||||||||||||||||||||
Short Display | Same source and target systems | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.id | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.id | ||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
ConceptMap.group.extension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.extension | ||||||||||||||||||||||||||||
Definition | 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 manageable, 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. | ||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.modifierExtension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.modifierExtension | ||||||||||||||||||||||||||||
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.source | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.source | ||||||||||||||||||||||||||||
Definition | An absolute URI that identifies the source system where the concepts to be mapped are defined. | ||||||||||||||||||||||||||||
Short Display | Source system where concepts to be mapped are defined | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(CodeSystem) | ||||||||||||||||||||||||||||
Comments | This is not needed if the source value set is specified and it contains concepts from only a single system. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.target | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.target | ||||||||||||||||||||||||||||
Definition | An absolute URI that identifies the target system that the concepts will be mapped to. | ||||||||||||||||||||||||||||
Short Display | Target system that the concepts are to be mapped to | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(CodeSystem) | ||||||||||||||||||||||||||||
Comments | This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element relationship values are 'not-related-to'. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element | ||||||||||||||||||||||||||||
Definition | Mappings for an individual concept in the source to one or more concepts in the target. | ||||||||||||||||||||||||||||
Short Display | Mappings for a concept from the source set | ||||||||||||||||||||||||||||
Cardinality | 1..* | ||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||
Alternate Names | code, concept, item | ||||||||||||||||||||||||||||
Comments | Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.id | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.id | ||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
ConceptMap.group.element.extension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.extension | ||||||||||||||||||||||||||||
Definition | 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 manageable, 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. | ||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.modifierExtension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.modifierExtension | ||||||||||||||||||||||||||||
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.code | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.code | ||||||||||||||||||||||||||||
Definition | Identity (code or path) or the element/item being mapped. | ||||||||||||||||||||||||||||
Short Display | Identifies element being mapped | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.display | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.display | ||||||||||||||||||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||||||||||||||||||
Short Display | Display for the code | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.valueSet | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.valueSet | ||||||||||||||||||||||||||||
Definition | The set of codes being mapped. | ||||||||||||||||||||||||||||
Short Display | Identifies elements being mapped | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.noMap | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.noMap | ||||||||||||||||||||||||||||
Definition | If noMap = true this indicates that no mapping to a target concept exists for this source concept. | ||||||||||||||||||||||||||||
Short Display | No mapping to a target concept for this source concept | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target | ||||||||||||||||||||||||||||
Definition | A concept from the target value set that this concept maps to. | ||||||||||||||||||||||||||||
Short Display | Concept in target system for element | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||
Comments | Ideally there would only be one map, with an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.id | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.id | ||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
ConceptMap.group.element.target.extension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.extension | ||||||||||||||||||||||||||||
Definition | 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 manageable, 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. | ||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.modifierExtension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.modifierExtension | ||||||||||||||||||||||||||||
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.code | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.code | ||||||||||||||||||||||||||||
Definition | Identity (code or path) or the element/item that the map refers to. | ||||||||||||||||||||||||||||
Short Display | Code that identifies the target element | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.display | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.display | ||||||||||||||||||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||||||||||||||||||
Short Display | Display for the code | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.valueSet | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.valueSet | ||||||||||||||||||||||||||||
Definition | The set of codes that the map refers to. | ||||||||||||||||||||||||||||
Short Display | Identifies the set of target elements | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.relationship | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.relationship | ||||||||||||||||||||||||||||
Definition | The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target). | ||||||||||||||||||||||||||||
Short Display | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Terminology Binding | The relationship between concepts. The codes SHALL be taken from ConceptMapRelationship | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between) | ||||||||||||||||||||||||||||
Comments | This element is labeled as a modifier because it may indicate that there is no mapping. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.comment | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.comment | ||||||||||||||||||||||||||||
Definition | A description of status/issues in mapping that conveys additional information not represented in the structured data. | ||||||||||||||||||||||||||||
Short Display | Description of status/issues in mapping | ||||||||||||||||||||||||||||
Cardinality | 0..1 This element is affected by the following invariants: cmd-1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn | ||||||||||||||||||||||||||||
Definition | A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified property can be resolved, and it has the specified value. | ||||||||||||||||||||||||||||
Short Display | Other properties required for this mapping | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.id | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.id | ||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.extension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.extension | ||||||||||||||||||||||||||||
Definition | 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 manageable, 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. | ||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.modifierExtension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.modifierExtension | ||||||||||||||||||||||||||||
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.property | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.property | ||||||||||||||||||||||||||||
Definition | A reference to a property that holds a value the map depends on. This value can be supplied to the $translate operation to select the appropriate targets. | ||||||||||||||||||||||||||||
Short Display | A reference to a property that may be required to refine the mapping | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.value[x] | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.value[x] | ||||||||||||||||||||||||||||
Definition | Property value that the map depends on. | ||||||||||||||||||||||||||||
Short Display | Value of the referenced property | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | Choice of: code, Coding, string, integer, boolean, dateTime, decimal, uri, id | ||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.dependsOn.valueSet | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.dependsOn.valueSet | ||||||||||||||||||||||||||||
Definition | This mapping applies if the property value is a code from this value set. | ||||||||||||||||||||||||||||
Short Display | The mapping depends on a property with a value from this value set | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.element.target.product | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.element.target.product | ||||||||||||||||||||||||||||
Definition | Product is the output of a ConceptMap that provides additional values relevant to the interpretation of the mapping target. | ||||||||||||||||||||||||||||
Short Display | Other properties that this mapping also produces | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | See ttp://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped | ||||||||||||||||||||||||||||
Definition | What to do when there is no mapping to a target concept from the source concept. This provides the "default" to be applied when there is no target concept mapping specified. The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to. | ||||||||||||||||||||||||||||
Short Display | What to do when there is no mapping target for the source concept | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | BackboneElement | ||||||||||||||||||||||||||||
Comments | This only applies if the source code has a system value that matches the system defined for the group. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.id | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.id | ||||||||||||||||||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||||||||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.extension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.extension | ||||||||||||||||||||||||||||
Definition | 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 manageable, 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. | ||||||||||||||||||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.modifierExtension | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.modifierExtension | ||||||||||||||||||||||||||||
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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||||||||||||||||||||||||
Short Display | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Extension | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) | ||||||||||||||||||||||||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||||||||||||||||||||||||
Alternate Names | extensions, user content, modifiers | ||||||||||||||||||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.mode | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.mode | ||||||||||||||||||||||||||||
Definition | 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). | ||||||||||||||||||||||||||||
Short Display | use-source-code | fixed | other-map | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Terminology Binding | Defines which action to take if there is no match in the group. The codes SHALL be taken from ConceptMapGroupUnmappedMode | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.code | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.code | ||||||||||||||||||||||||||||
Definition | The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code. | ||||||||||||||||||||||||||||
Short Display | Fixed code when mode = fixed | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.display | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.display | ||||||||||||||||||||||||||||
Definition | The display for the code. The display is only provided to help editors when editing the concept map. | ||||||||||||||||||||||||||||
Short Display | Display for the code | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Comments | The display is ignored when processing the map. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.valueSet | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.valueSet | ||||||||||||||||||||||||||||
Definition | The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes. | ||||||||||||||||||||||||||||
Short Display | Fixed code set when mode = fixed | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(ValueSet) | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.relationship | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.relationship | ||||||||||||||||||||||||||||
Definition | The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'. | ||||||||||||||||||||||||||||
Short Display | related-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Terminology Binding | The default relationship value to apply between the source and target concepts when no concept mapping is specified. The codes SHALL be taken from ConceptMapRelationship | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: The 'not-related-to' relationship means that there is no mapping from the source to the target, and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between) | ||||||||||||||||||||||||||||
Comments | This element is labeled as a modifier because it may indicate that there is no mapping. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
ConceptMap.group.unmapped.otherMap | |||||||||||||||||||||||||||||
Element Id | ConceptMap.group.unmapped.otherMap | ||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||
Short Display | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(ConceptMap) | ||||||||||||||||||||||||||||
Invariants |
|