Coding Mapping Extension¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-coding-mapping |
|---|---|
| Status | draft · 1.33.0 |
| Base | Extension (constraint) |
| Context | CodeableConcept.coding (element) |
| Source | FSH · JSON |
How faithfully this coding represents the concept its CodeableConcept expresses, when the coding was added by translation rather than chosen.
Elements / Details
Every element this profile touches, with its full definition. Element names in the tables link here.
Extension¶
| Short | How faithfully this translated coding represents the intended concept |
|---|---|
| Definition | How faithfully this coding represents the concept its CodeableConcept expresses, when the coding was
added by translation rather than chosen.
The containing CodeableConcept is the SOURCE and this coding the TARGET, with the meaning of R4
ConceptMap.group.element.target.equivalence. The source is implicit: the single sibling coding
with userSelected = true where there is exactly one, and otherwise CodeableConcept.text.
comment says what the structured relationship cannot, and is required for narrower and
inexact.
The relationship is a statement about meaning, not about confidence: a translation can be certain
and still inexact. It is copied from the mapping that produced the coding, never defaulted.
R5 carries the same relationship as ConceptMap...target.relationship: equivalent and equal
map to equivalent; wider to source-is-narrower-than-target; narrower to
source-is-broader-than-target; subsumes, specializes, inexact and relatedto to
related-to, which loses the distinction. |
| Cardinality | 0..* |
| Invariants | ele-1, ext-1, nexus-cm-1 |
Extension.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
| 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. |
| Cardinality | 1..* |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:equivalence¶
| Short | equivalent | equal | wider | subsumes | narrower | specializes | inexact | relatedto |
|---|---|
| Definition | The relationship of this coding (the target) to the concept the CodeableConcept expresses (the source), as R4 ConceptMap target equivalence defines it. |
| 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. |
| Cardinality | 1..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:equivalence.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:equivalence.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
| 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. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:equivalence.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | equivalence |
Extension.extension:equivalence.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..1 |
| Type | code |
| Binding | Coding Mapping Equivalence Value Set (required) |
| Invariants | ele-1 |
Extension.extension:comment¶
| Short | What the relationship code cannot say; required for narrower and inexact |
|---|---|
| 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. |
| 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. |
| Cardinality | 0..1 |
| Type | Extension |
| Must Support | yes |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:comment.id¶
| Short | Unique id for inter-element referencing |
|---|---|
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Cardinality | 0..1 |
| Type | http://hl7.org/fhirpath/System.String |
Extension.extension:comment.extension¶
| Short | Additional content defined by implementations |
|---|---|
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
| 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. |
| Cardinality | 0..0 |
| Type | Extension |
| Invariants | ele-1, ext-1 |
| Also called | extensions, user content |
Extension.extension:comment.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | comment |
Extension.extension:comment.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..1 |
| Type | string |
| Invariants | ele-1 |
Extension.url¶
| Short | identifies the meaning of the extension |
|---|---|
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
| Cardinality | 1..1 |
| Type | http://hl7.org/fhirpath/System.String |
| Fixed value | https://fhir.apps.health/StructureDefinition/nexus-coding-mapping |
Extension.value[x]¶
| Short | Value of extension |
|---|---|
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Cardinality | 0..0 |
| Type | base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta |
| Invariants | ele-1 |