{ "resourceType": "StructureDefinition", "id": "general-concept-map-2", "text": { "status": "generated", "div": "

NCTS General Concept Map

URL
https://healthterminologies.gov.au/fhir/StructureDefinition/general-concept-map-2
Base Definition
http://hl7.org/fhir/StructureDefinition/ConceptMap
Status
ACTIVE
Publisher
Australian Digital Health Agency
Description
This StructureDefinition describes the NCTS General Concept Map, a profile of the FHIR® CodeSystem resource. The NCTS General Concept Map is designed to represent mappings between terminologies published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.

Elements (Snapshot)

PathCardinalityTypeDefinition
ConceptMap0..*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.
ConceptMap.id0..1 id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ConceptMap.meta0..1 Meta 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.
ConceptMap.implicitRules0..0 uri A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
ConceptMap.language0..1 code The base language in which the resource is written.
ConceptMap.text1..1 Narrative 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.
ConceptMap.contained0..0 Resource 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.
ConceptMap.extension0..* Extension 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.
ConceptMap.modifierExtension0..0 Extension 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.
ConceptMap.url1..1 uri An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).
ConceptMap.identifier1..1 Identifier 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.
ConceptMap.identifier.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ConceptMap.identifier.extension0..* Extension 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.
ConceptMap.identifier.use0..1 code The purpose of this identifier.
ConceptMap.identifier.type0..1 CodeableConcept A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
ConceptMap.identifier.system1..1 uri Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
ConceptMap.identifier.value1..1 string The portion of the identifier typically relevant to the user and which is unique within the context of the system.
ConceptMap.identifier.period0..1 Period Time period during which identifier is/was valid for use.
ConceptMap.identifier.assigner0..1 Reference Organization that issued/manages the identifier.
ConceptMap.version1..1 string 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.
ConceptMap.name1..1 string 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.
ConceptMap.title0..1 string A short, descriptive, user-friendly title for the concept map.
ConceptMap.status1..1 code The status of this concept map. Enables tracking the life-cycle of the content.
ConceptMap.experimental1..1 boolean 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.
ConceptMap.date1..1 dateTime 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.
ConceptMap.publisher1..1 string The name of the individual or organization that published the concept map.
ConceptMap.contact0..* ContactDetail Contact details to assist a user in finding and communicating with the publisher.
ConceptMap.contact.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ConceptMap.contact.extension0..* Extension 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.
ConceptMap.contact.name0..1 string The name of an individual to contact.
ConceptMap.contact.telecom1..* ContactPoint The contact details for the individual (if a name was provided) or the organization.
ConceptMap.description1..1 markdown A free text natural language description of the concept map from a consumer's perspective.
ConceptMap.useContext0..* UsageContext 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.
ConceptMap.jurisdiction0..* CodeableConcept A legal or geographic region in which the concept map is intended to be used.
ConceptMap.purpose0..1 markdown Explaination of why this concept map is needed and why it has been designed as it has.
ConceptMap.copyright1..1 markdown 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.
ConceptMap.source[x]1..1 [ uri | Reference ] The source value set that specifies the concepts that are being mapped.
ConceptMap.target[x]1..1 [ uri | Reference ] 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.
ConceptMap.group0..* BackboneElement A group of mappings that all have the same source and target system.
ConceptMap.group.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ConceptMap.group.extension0..* Extension 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.
ConceptMap.group.modifierExtension0..* Extension 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.
ConceptMap.group.source0..1 uri An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).
ConceptMap.group.sourceVersion0..1 string The specific version of the code system, as determined by the code system authority.
ConceptMap.group.target0..1 uri An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems).
ConceptMap.group.targetVersion0..1 string The specific version of the code system, as determined by the code system authority.
ConceptMap.group.element1..* BackboneElement Mappings for an individual concept in the source to one or more concepts in the target.
ConceptMap.group.element.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ConceptMap.group.element.extension0..* Extension 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.
ConceptMap.group.element.modifierExtension0..* Extension 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.
ConceptMap.group.element.code1..1 code Identity (code or path) or the element/item being mapped.
ConceptMap.group.element.display0..1 string The display for the code. The display is only provided to help editors when editing the concept map.
ConceptMap.group.element.target1..* BackboneElement A concept from the target value set that this concept maps to.
ConceptMap.group.element.target.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ConceptMap.group.element.target.extension0..* Extension 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.
ConceptMap.group.element.target.modifierExtension0..* Extension 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.
ConceptMap.group.element.target.code0..1 code Identity (code or path) or the element/item that the map refers to.
ConceptMap.group.element.target.display0..1 string The display for the code. The display is only provided to help editors when editing the concept map.
ConceptMap.group.element.target.equivalence0..1 code 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).
ConceptMap.group.element.target.comment0..1 string A description of status/issues in mapping that conveys additional information not represented in the structured data.
ConceptMap.group.element.target.dependsOn0..0 BackboneElement 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.
ConceptMap.group.element.target.dependsOn.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ConceptMap.group.element.target.dependsOn.extension0..* Extension 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.
ConceptMap.group.element.target.dependsOn.modifierExtension0..* Extension 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.
ConceptMap.group.element.target.dependsOn.property1..1 uri 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.
ConceptMap.group.element.target.dependsOn.system0..1 uri An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).
ConceptMap.group.element.target.dependsOn.code1..1 string Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.
ConceptMap.group.element.target.dependsOn.display0..1 string The display for the code. The display is only provided to help editors when editing the concept map.
ConceptMap.group.element.target.product0..0 see ConceptMap.group.element.target.dependsOn 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.
ConceptMap.group.unmapped0..1 BackboneElement What to do when there is no match in the mappings in the group.
ConceptMap.group.unmapped.id0..1 string unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ConceptMap.group.unmapped.extension0..* Extension 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.
ConceptMap.group.unmapped.modifierExtension0..* Extension 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.
ConceptMap.group.unmapped.mode1..1 code 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).
ConceptMap.group.unmapped.code0..1 code The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.
ConceptMap.group.unmapped.display0..1 string The display for the code. The display is only provided to help editors when editing the concept map.
ConceptMap.group.unmapped.url0..1 uri The canonical URL of the map to use if this map contains no mapping.
" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "vocab" } ], "url": "https://healthterminologies.gov.au/fhir/StructureDefinition/general-concept-map-2", "version": "2.1.0", "name": "NCTS General Concept Map", "title": "NCTS General Concept Map", "status": "active", "date": "2018-01-16", "publisher": "Australian Digital Health Agency", "description": "This StructureDefinition describes the NCTS General Concept Map, a profile of the FHIR® CodeSystem resource. The NCTS General Concept Map is designed to represent mappings between terminologies published as part of the National Clinical Terminology Service, and maximise interoperability within the NCTS ecosystem.", "purpose": "The purpose of this profile is to codify a set of general best practices with respect to representing concept maps in FHIR, and an opinionated approach to versioning that is compatible with the syndication model that NCTS uses.", "fhirVersion": "3.0.1", "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", "differential": { "element": [ { "id": "ConceptMap.implicitRules", "path": "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.", "max": "0" }, { "id": "ConceptMap.text", "path": "ConceptMap.text", "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.", "min": 1 }, { "id": "ConceptMap.contained", "path": "ConceptMap.contained", "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.", "max": "0" }, { "id": "ConceptMap.url", "path": "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. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions).", "min": 1 }, { "id": "ConceptMap.identifier", "path": "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.", "min": 1 }, { "id": "ConceptMap.identifier.system", "path": "ConceptMap.identifier.system", "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "min": 1, "fixedUri": "urn:ietf:rfc:3986" }, { "id": "ConceptMap.identifier.value", "path": "ConceptMap.identifier.value", "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "min": 1 }, { "id": "ConceptMap.version", "path": "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.", "min": 1 }, { "id": "ConceptMap.name", "path": "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.", "min": 1 }, { "id": "ConceptMap.experimental", "path": "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.", "min": 1 }, { "id": "ConceptMap.date", "path": "ConceptMap.date", "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.", "min": 1 }, { "id": "ConceptMap.publisher", "path": "ConceptMap.publisher", "definition": "The name of the individual or organization that published the concept map.", "min": 1 }, { "id": "ConceptMap.contact.name", "path": "ConceptMap.contact.name", "definition": "The name of an individual to contact.", "min": 0, "max": "1" }, { "id": "ConceptMap.contact.telecom", "path": "ConceptMap.contact.telecom", "definition": "The contact details for the individual (if a name was provided) or the organization.", "min": 1 }, { "id": "ConceptMap.description", "path": "ConceptMap.description", "definition": "A free text natural language description of the concept map from a consumer's perspective.", "min": 1 }, { "id": "ConceptMap.copyright", "path": "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.", "min": 1 }, { "id": "ConceptMap.source[x]", "path": "ConceptMap.source[x]", "definition": "The source value set that specifies the concepts that are being mapped.", "min": 1 }, { "id": "ConceptMap.target[x]", "path": "ConceptMap.target[x]", "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.", "min": 1 }, { "id": "ConceptMap.group.element.code", "path": "ConceptMap.group.element.code", "definition": "Identity (code or path) or the element/item being mapped.", "min": 1 }, { "id": "ConceptMap.group.element.target", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "TargetElement" } ], "path": "ConceptMap.group.element.target", "definition": "A concept from the target value set that this concept maps to.", "min": 1 }, { "id": "ConceptMap.group.element.target.dependsOn", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString": "OtherElement" } ], "path": "ConceptMap.group.element.target.dependsOn", "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.", "max": "0" }, { "id": "ConceptMap.group.element.target.product", "path": "ConceptMap.group.element.target.product", "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.", "max": "0" }, { "id": "ConceptMap.modifierExtension", "path": "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. 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.", "max": "0" } ] } }