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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringConceptMapThis is a ConceptMap resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the concept map.
statusstringdraft|active|retired|unknownThe status of this concept map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the concept map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the concept map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the concept map is intended to be used.
purposestringExplaination of why this concept map is needed and why it has been designed as it has.
copyrightstringA 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.
sourceUristringThe source value set that specifies the concepts that are being mapped.
sourceReferenceReferenceThe source value set that specifies the concepts that are being mapped.
targetUristringThe 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.
targetReferenceReferenceThe 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.
grouparray(ConceptMap_Group)A group of mappings that all have the same source and target system.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringConceptMapThis is a ConceptMap resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the concept map.
statusstringdraft|active|retired|unknownThe status of this concept map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the concept map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the concept map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the concept map is intended to be used.
purposestringExplaination of why this concept map is needed and why it has been designed as it has.
copyrightstringA 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.
sourceUristringThe source value set that specifies the concepts that are being mapped.
sourceReferenceReferenceThe source value set that specifies the concepts that are being mapped.
targetUristringThe 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.
targetReferenceReferenceThe 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.
grouparray(ConceptMap_Group)A group of mappings that all have the same source and target system.

Response

Read Concept Map

get
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Concept Map

get
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Concept Map

get
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Concept Map

delete
/organizations/{organizationId}/fhir/3/ConceptMap/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Concept Map

get
/organizations/{organizationId}/fhir/3/ConceptMap

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
dependsonstring
descriptionstring
identifierstring
jurisdictionstring
namestring
otherstring
productstring
publisherstring
sourcestring
source-codestring
source-systemstring
source-uristring
statusstring
targetstring
target-codestring
target-systemstring
target-uristring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Concept Map

get
/organizations/{organizationId}/fhir/3/ConceptMap/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
dependsonstring
descriptionstring
identifierstring
jurisdictionstring
namestring
otherstring
productstring
publisherstring
sourcestring
source-codestring
source-systemstring
source-uristring
statusstring
targetstring
target-codestring
target-systemstring
target-uristring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringConceptMapThis is a ConceptMap resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the concept map.
statusstringdraft|active|retired|unknownThe status of this concept map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the concept map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the concept map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the concept map is intended to be used.
purposestringExplaination of why this concept map is needed and why it has been designed as it has.
copyrightstringA 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.
sourceUristringThe source value set that specifies the concepts that are being mapped.
sourceReferenceReferenceThe source value set that specifies the concepts that are being mapped.
targetUristringThe 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.
targetReferenceReferenceThe 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.
grouparray(ConceptMap_Group)A group of mappings that all have the same source and target system.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringConceptMapThis is a ConceptMap resource
urlstringAn 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).
identifierIdentifierA 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.
versionstringThe 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.
namestringA 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.
titlestringA short, descriptive, user-friendly title for the concept map.
statusstringdraft|active|retired|unknownThe status of this concept map. Enables tracking the life-cycle of the content.
experimentalbooleanA 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.
datestringThe 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.
publisherstringThe name of the individual or organization that published the concept map.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the concept map from a consumer's perspective.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the concept map is intended to be used.
purposestringExplaination of why this concept map is needed and why it has been designed as it has.
copyrightstringA 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.
sourceUristringThe source value set that specifies the concepts that are being mapped.
sourceReferenceReferenceThe source value set that specifies the concepts that are being mapped.
targetUristringThe 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.
targetReferenceReferenceThe 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.
grouparray(ConceptMap_Group)A group of mappings that all have the same source and target system.

Response