Implementation Guide
23.1.0 - R4 APIs
Publish Box goes here
Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition/athena-conceptmap-profile | Version: 23.1.0 | |||
Active as of 2022-03-01 | Computable Name: AthenaConceptMap |
Defines constraints and extensions on the Binary resource as supported by Athena Products.
This ConceptMap profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.
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.
This profile is used to define the content that will be returned by the API Server in response to requests to access ConceptMap resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ConceptMap
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | 0..* | ConceptMap | A map from one set of concepts to one or more other concepts | |
url | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | |
identifier | 0..1 | Identifier | Additional identifier for the concept map | |
version | 0..1 | string | Business version of the concept map | |
name | 0..1 | string | Name for this concept map (computer friendly) | |
status | S | 1..1 | code | draft | active | retired | unknown |
experimental | 0..1 | boolean | For testing purposes, not real usage | |
date | 0..1 | dateTime | Date last changed | |
publisher | 0..1 | string | Name of the publisher (organization or individual) | |
contact | 0..* | ContactDetail | Contact details for the publisher | |
description | 0..1 | markdown | Natural language description of the concept map | |
useContext | 0..* | UsageContext | The context that the content is intended to support | |
purpose | 0..1 | markdown | Why this concept map is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
source[x] | 0..1 | uri | The source value set that contains the concepts that are being mapped | |
target[x] | 0..1 | uri | The target value set which provides context for the mappings | |
group | 0..* | BackboneElement | Same source and target systems | |
source | 0..1 | uri | Source system where concepts to be mapped are defined | |
target | 0..1 | uri | Target system that the concepts are to be mapped to | |
element | S | 1..* | BackboneElement | Mappings for a concept from the source set |
code | 0..1 | code | Identifies element being mapped | |
target | 0..* | BackboneElement | Concept in target system for element | |
code | 0..1 | code | Code that identifies the target element | |
equivalence | S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint |
comment | 0..1 | string | Description of status/issues in mapping | |
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |
property | S | 1..1 | uri | Reference to property mapping depends on |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | S | 1..1 | string | Value of the referenced element |
product | 0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | C | 0..* | ConceptMap | A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) |
identifier | Σ | 0..1 | Identifier | Additional identifier for the concept map |
version | Σ | 0..1 | string | Business version of the concept map |
name | ΣC | 0..1 | string | Name for this concept map (computer friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the concept map | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
purpose | 0..1 | markdown | Why this concept map is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
source[x] | Σ | 0..1 | uri | The source value set that contains the concepts that are being mapped |
target[x] | Σ | 0..1 | uri | The target value set which provides context for the mappings |
group | 0..* | BackboneElement | Same source and target systems | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
source | 0..1 | uri | Source system where concepts to be mapped are defined | |
target | 0..1 | uri | Target system that the concepts are to be mapped to | |
element | S | 1..* | BackboneElement | Mappings for a concept from the source set |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | code | Identifies element being mapped | |
target | C | 0..* | BackboneElement | Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | code | Code that identifies the target element | |
equivalence | ?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. |
comment | C | 0..1 | string | Description of status/issues in mapping |
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | S | 1..1 | uri | Reference to property mapping depends on |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | S | 1..1 | string | Value of the referenced element |
product | 0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ConceptMap | C | 0..* | ConceptMap | A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||
identifier | Σ | 0..1 | Identifier | Additional identifier for the concept map | ||||
version | Σ | 0..1 | string | Business version of the concept map | ||||
name | ΣC | 0..1 | string | Name for this concept map (computer friendly) | ||||
title | Σ | 0..1 | string | Name for this concept map (human friendly) | ||||
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | 0..1 | markdown | Natural language description of the concept map | |||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this concept map is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
source[x] | Σ | 0..1 | uri | The source value set that contains the concepts that are being mapped | ||||
target[x] | Σ | 0..1 | uri | The target value set which provides context for the mappings | ||||
group | 0..* | BackboneElement | Same source and target systems | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
source | 0..1 | uri | Source system where concepts to be mapped are defined | |||||
sourceVersion | 0..1 | string | Specific version of the code system | |||||
target | 0..1 | uri | Target system that the concepts are to be mapped to | |||||
targetVersion | 0..1 | string | Specific version of the code system | |||||
element | S | 1..* | BackboneElement | Mappings for a concept from the source set | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | code | Identifies element being mapped | |||||
display | 0..1 | string | Display for the code | |||||
target | C | 0..* | BackboneElement | Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | code | Code that identifies the target element | |||||
display | 0..1 | string | Display for the code | |||||
equivalence | ?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | ||||
comment | C | 0..1 | string | Description of status/issues in mapping | ||||
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
property | S | 1..1 | uri | Reference to property mapping depends on | ||||
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |||||
value | S | 1..1 | string | Value of the referenced element | ||||
display | 0..1 | string | Display for the code (if value is a code) | |||||
product | 0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |||||
unmapped | C | 0..1 | BackboneElement | What to do when there is no mapping for the source concept cmd-2: If the mode is 'fixed', a code must be provided cmd-3: If the mode is 'other-map', a url must be provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | 1..1 | code | provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group. | |||||
code | 0..1 | code | Fixed code when mode = fixed | |||||
display | 0..1 | string | Display for the code | |||||
url | 0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ConceptMap.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
ConceptMap.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1 from the FHIR Standard | ||||
ConceptMap.group.unmapped.mode | required | ConceptMapGroupUnmappedModehttp://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1 from the FHIR Standard |
This structure is derived from ConceptMap
Differential View
This structure is derived from ConceptMap
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | 0..* | ConceptMap | A map from one set of concepts to one or more other concepts | |
url | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | |
identifier | 0..1 | Identifier | Additional identifier for the concept map | |
version | 0..1 | string | Business version of the concept map | |
name | 0..1 | string | Name for this concept map (computer friendly) | |
status | S | 1..1 | code | draft | active | retired | unknown |
experimental | 0..1 | boolean | For testing purposes, not real usage | |
date | 0..1 | dateTime | Date last changed | |
publisher | 0..1 | string | Name of the publisher (organization or individual) | |
contact | 0..* | ContactDetail | Contact details for the publisher | |
description | 0..1 | markdown | Natural language description of the concept map | |
useContext | 0..* | UsageContext | The context that the content is intended to support | |
purpose | 0..1 | markdown | Why this concept map is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
source[x] | 0..1 | uri | The source value set that contains the concepts that are being mapped | |
target[x] | 0..1 | uri | The target value set which provides context for the mappings | |
group | 0..* | BackboneElement | Same source and target systems | |
source | 0..1 | uri | Source system where concepts to be mapped are defined | |
target | 0..1 | uri | Target system that the concepts are to be mapped to | |
element | S | 1..* | BackboneElement | Mappings for a concept from the source set |
code | 0..1 | code | Identifies element being mapped | |
target | 0..* | BackboneElement | Concept in target system for element | |
code | 0..1 | code | Code that identifies the target element | |
equivalence | S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint |
comment | 0..1 | string | Description of status/issues in mapping | |
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |
property | S | 1..1 | uri | Reference to property mapping depends on |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | S | 1..1 | string | Value of the referenced element |
product | 0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | C | 0..* | ConceptMap | A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) |
identifier | Σ | 0..1 | Identifier | Additional identifier for the concept map |
version | Σ | 0..1 | string | Business version of the concept map |
name | ΣC | 0..1 | string | Name for this concept map (computer friendly) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the concept map | |
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support |
purpose | 0..1 | markdown | Why this concept map is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
source[x] | Σ | 0..1 | uri | The source value set that contains the concepts that are being mapped |
target[x] | Σ | 0..1 | uri | The target value set which provides context for the mappings |
group | 0..* | BackboneElement | Same source and target systems | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
source | 0..1 | uri | Source system where concepts to be mapped are defined | |
target | 0..1 | uri | Target system that the concepts are to be mapped to | |
element | S | 1..* | BackboneElement | Mappings for a concept from the source set |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | code | Identifies element being mapped | |
target | C | 0..* | BackboneElement | Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | 0..1 | code | Code that identifies the target element | |
equivalence | ?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. |
comment | C | 0..1 | string | Description of status/issues in mapping |
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
property | S | 1..1 | uri | Reference to property mapping depends on |
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |
value | S | 1..1 | string | Value of the referenced element |
product | 0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ConceptMap | C | 0..* | ConceptMap | A map from one set of concepts to one or more other concepts cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Canonical identifier for this concept map, represented as a URI (globally unique) | ||||
identifier | Σ | 0..1 | Identifier | Additional identifier for the concept map | ||||
version | Σ | 0..1 | string | Business version of the concept map | ||||
name | ΣC | 0..1 | string | Name for this concept map (computer friendly) | ||||
title | Σ | 0..1 | string | Name for this concept map (human friendly) | ||||
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 0..1 | dateTime | Date last changed | ||||
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
contact | Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
description | 0..1 | markdown | Natural language description of the concept map | |||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for concept map (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
purpose | 0..1 | markdown | Why this concept map is defined | |||||
copyright | 0..1 | markdown | Use and/or publishing restrictions | |||||
source[x] | Σ | 0..1 | uri | The source value set that contains the concepts that are being mapped | ||||
target[x] | Σ | 0..1 | uri | The target value set which provides context for the mappings | ||||
group | 0..* | BackboneElement | Same source and target systems | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
source | 0..1 | uri | Source system where concepts to be mapped are defined | |||||
sourceVersion | 0..1 | string | Specific version of the code system | |||||
target | 0..1 | uri | Target system that the concepts are to be mapped to | |||||
targetVersion | 0..1 | string | Specific version of the code system | |||||
element | S | 1..* | BackboneElement | Mappings for a concept from the source set | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | code | Identifies element being mapped | |||||
display | 0..1 | string | Display for the code | |||||
target | C | 0..* | BackboneElement | Concept in target system for element cmd-1: If the map is narrower or inexact, there SHALL be some comments | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | 0..1 | code | Code that identifies the target element | |||||
display | 0..1 | string | Display for the code | |||||
equivalence | ?!S | 1..1 | code | relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint Binding: ConceptMapEquivalence (required): The degree of equivalence between concepts. | ||||
comment | C | 0..1 | string | Description of status/issues in mapping | ||||
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
property | S | 1..1 | uri | Reference to property mapping depends on | ||||
system | 0..1 | canonical(CodeSystem) | Code System (if necessary) | |||||
value | S | 1..1 | string | Value of the referenced element | ||||
display | 0..1 | string | Display for the code (if value is a code) | |||||
product | 0..* | See dependsOn (ConceptMap) | Other concepts that this mapping also produces | |||||
unmapped | C | 0..1 | BackboneElement | What to do when there is no mapping for the source concept cmd-2: If the mode is 'fixed', a code must be provided cmd-3: If the mode is 'other-map', a url must be provided | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
mode | 1..1 | code | provided | fixed | other-map Binding: ConceptMapGroupUnmappedMode (required): Defines which action to take if there is no match in the group. | |||||
code | 0..1 | code | Fixed code when mode = fixed | |||||
display | 0..1 | string | Display for the code | |||||
url | 0..1 | canonical(ConceptMap) | canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ConceptMap.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ConceptMap.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
ConceptMap.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
ConceptMap.group.element.target.equivalence | required | ConceptMapEquivalencehttp://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1 from the FHIR Standard | ||||
ConceptMap.group.unmapped.mode | required | ConceptMapGroupUnmappedModehttp://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1 from the FHIR Standard |
This structure is derived from ConceptMap
Other representations of profile: CSV, Excel, Schematron
The Interactions supported by this resource are listed below.
Search parameters are executed as specified in the HL7 FHIR RESTful API implementation definition. To search for Organization resources, an application shall perform an HTTP GET, specifying the query parameters associated with the resource.
ConceptMap resources can be enumerated by retrieving the fhir/List resource with an id of ConceptMap
GET [base]/fhir/R4/List/ConceptMap?{_format=[json|xml]&_summary=[true|text|data]}
Where:
Name | Description |
---|---|
[base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
[_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
[_summary] | Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets. |
The following HTTP response codes are returned by this API call:
200 OK | The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found. |
401 Unauthorized | Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required. |
500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
The following additional operation is available.
Translate a code from one value set to another, based on the existing value set and concept maps resources.
See $translate OperationDefinition for more detail.