concept maps
Create Concept Map
post
/organizations/{organizationId}/fhir/3/ConceptMap
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.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | ConceptMap | This is a ConceptMap resource |
| url | string | 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). | |
| identifier | 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. | |
| version | 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. | |
| name | 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. | |
| title | string | A short, descriptive, user-friendly title for the concept map. | |
| status | string | draft|active|retired|unknown | The status of this concept map. Enables tracking the life-cycle of the content. |
| experimental | 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. | |
| date | string | 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. | |
| publisher | string | The name of the individual or organization that published the concept map. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the concept map from a consumer's perspective. | |
| useContext | array(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. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the concept map is intended to be used. | |
| purpose | string | Explaination of why this concept map is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| sourceUri | string | The source value set that specifies the concepts that are being mapped. | |
| sourceReference | Reference | The source value set that specifies the concepts that are being mapped. | |
| targetUri | string | 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. | |
| targetReference | 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. | |
| group | array(ConceptMap_Group) | A group of mappings that all have the same source and target system. |
Response
keyboard_arrow_down
Patch Concept Map
patch
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}
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.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | ConceptMap | This is a ConceptMap resource |
| url | string | 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). | |
| identifier | 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. | |
| version | 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. | |
| name | 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. | |
| title | string | A short, descriptive, user-friendly title for the concept map. | |
| status | string | draft|active|retired|unknown | The status of this concept map. Enables tracking the life-cycle of the content. |
| experimental | 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. | |
| date | string | 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. | |
| publisher | string | The name of the individual or organization that published the concept map. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the concept map from a consumer's perspective. | |
| useContext | array(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. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the concept map is intended to be used. | |
| purpose | string | Explaination of why this concept map is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| sourceUri | string | The source value set that specifies the concepts that are being mapped. | |
| sourceReference | Reference | The source value set that specifies the concepts that are being mapped. | |
| targetUri | string | 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. | |
| targetReference | 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. | |
| group | array(ConceptMap_Group) | A group of mappings that all have the same source and target system. |
Response
keyboard_arrow_down
Read Concept Map
get
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Concept Map
get
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Concept Map
get
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Concept Map
delete
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Concept Map
get
/organizations/{organizationId}/fhir/3/ConceptMap
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| date | string | ||
| dependson | string | ||
| description | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| other | string | ||
| product | string | ||
| publisher | string | ||
| source | string | ||
| source-code | string | ||
| source-system | string | ||
| source-uri | string | ||
| status | string | ||
| target | string | ||
| target-code | string | ||
| target-system | string | ||
| target-uri | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Concept Map
get
/organizations/{organizationId}/fhir/3/ConceptMap/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Concept Map
post
/organizations/{organizationId}/fhir/3/ConceptMap/_search
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.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| date | string | ||
| dependson | string | ||
| description | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| other | string | ||
| product | string | ||
| publisher | string | ||
| source | string | ||
| source-code | string | ||
| source-system | string | ||
| source-uri | string | ||
| status | string | ||
| target | string | ||
| target-code | string | ||
| target-system | string | ||
| target-uri | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | ConceptMap | This is a ConceptMap resource |
| url | string | 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). | |
| identifier | 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. | |
| version | 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. | |
| name | 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. | |
| title | string | A short, descriptive, user-friendly title for the concept map. | |
| status | string | draft|active|retired|unknown | The status of this concept map. Enables tracking the life-cycle of the content. |
| experimental | 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. | |
| date | string | 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. | |
| publisher | string | The name of the individual or organization that published the concept map. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the concept map from a consumer's perspective. | |
| useContext | array(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. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the concept map is intended to be used. | |
| purpose | string | Explaination of why this concept map is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| sourceUri | string | The source value set that specifies the concepts that are being mapped. | |
| sourceReference | Reference | The source value set that specifies the concepts that are being mapped. | |
| targetUri | string | 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. | |
| targetReference | 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. | |
| group | array(ConceptMap_Group) | A group of mappings that all have the same source and target system. |
Response
keyboard_arrow_down
Update Concept Map
put
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}
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.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | ConceptMap | This is a ConceptMap resource |
| url | string | 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). | |
| identifier | 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. | |
| version | 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. | |
| name | 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. | |
| title | string | A short, descriptive, user-friendly title for the concept map. | |
| status | string | draft|active|retired|unknown | The status of this concept map. Enables tracking the life-cycle of the content. |
| experimental | 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. | |
| date | string | 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. | |
| publisher | string | The name of the individual or organization that published the concept map. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| description | string | A free text natural language description of the concept map from a consumer's perspective. | |
| useContext | array(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. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the concept map is intended to be used. | |
| purpose | string | Explaination of why this concept map is needed and why it has been designed as it has. | |
| copyright | string | 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. | |
| sourceUri | string | The source value set that specifies the concepts that are being mapped. | |
| sourceReference | Reference | The source value set that specifies the concepts that are being mapped. | |
| targetUri | string | 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. | |
| targetReference | 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. | |
| group | array(ConceptMap_Group) | A group of mappings that all have the same source and target system. |
Response
keyboard_arrow_down