# HeyDonto FHIR R4 API - Terminology The Terminology Module provides an overview and guide to the FHIR resources, operations, coded data types and externally-defined standard and FHIR-defined terminologies that are used for representing and communicating coded, structured data in the FHIR core specification and profiles. Collectively, these capabilities are used to provide the terminology service functionality required for supporting the use of coded data in FHIR resources throughout the specification as described in the other modules. The primary terminology-related structures and their relationships are shown below: ![Terminology Resources Relationships](/images/terminology-module-relationships.png) **Example: Condition profile with Condition.code slice bound to "SNOMED CT fracture codes" value set** [Note: The ElementDefinition type (shown with a dotted box) is described elsewhere in the specification in the [Foundation](https://hl7.org/fhir/R4/foundation-module.html) and [Conformance](https://hl7.org/fhir/R4/conformance-module.html) modules.] --- ## Index The Terminology Module covers the following: **Resources:** * [CodeSystem](https://hl7.org/fhir/R4/codesystem.html) - The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content * [ValueSet](https://hl7.org/fhir/R4/valueset.html) - A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements * [ConceptMap](https://hl7.org/fhir/R4/conceptmap.html) - A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models * [NamingSystem](https://hl7.org/fhir/R4/namingsystem.html) - A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types * [TerminologyCapabilities](https://hl7.org/fhir/R4/terminologycapabilities.html) - A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation **Terminology Service:** * [Terminology Service Documentation](https://hl7.org/fhir/R4/terminology-service.html) **Operations:** *CodeSystem:* * [$lookup](https://hl7.org/fhir/R4/codesystem-operation-lookup.html) * [$validate-code](https://hl7.org/fhir/R4/codesystem-operation-validate-code.html) * [$subsumes](https://hl7.org/fhir/R4/codesystem-operation-subsumes.html) * [$find-matches](https://hl7.org/fhir/R4/codesystem-operation-find-matches.html) *ValueSet:* * [$expand](https://hl7.org/fhir/R4/valueset-operation-expand.html) * [$validate-code](https://hl7.org/fhir/R4/valueset-operation-validate-code.html) *ConceptMap:* * [$translate](https://hl7.org/fhir/R4/conceptmap-operation-translate.html) * [$closure](https://hl7.org/fhir/R4/conceptmap-operation-closure.html) **Coded Data Types:** * [code](https://hl7.org/fhir/R4/datatypes.html#code) * [Coding](https://hl7.org/fhir/R4/datatypes.html#Coding) * [CodeableConcept](https://hl7.org/fhir/R4/datatypes.html#CodeableConcept) **Documentation:** * [Using Codes in Resources](https://hl7.org/fhir/R4/terminologies.html) * [Code Systems Defined/Referenced in FHIR](https://hl7.org/fhir/R4/terminologies-systems.html) * [Value Sets Defined in FHIR](https://hl7.org/fhir/R4/terminologies-valuesets.html) * [Mappings (FHIR-defined) Between Related Value Set Concepts](https://hl7.org/fhir/R4/terminologies-conceptmaps.html) * [Known Identifier Systems](https://hl7.org/fhir/R4/identifier-registry.html) --- ## Security and Privacy For security considerations for terminology services, see the [Terminology Service page Security section](https://hl7.org/fhir/R4/terminology-service.html#4.6.1). For more general considerations, see the [Security and Privacy module](https://hl7.org/fhir/R4/secpriv-module.html). --- ## Common Use Cases * Create or reference a code system * Create or reference a value set * Record data using pre-coordinated codes * Record data using post-coordinated expressions * Record data using multiple local or standard code systems (translations) * Expand a value set * Validate a code * Look up a display term for a code * Translate a code from one value set to another * Maintain a client-side [transitive closure table](https://en.wikipedia.org/wiki/Transitive_closure#In_graph_theory) on subsumption relationships * Test subsumption between concepts * For a set of property/concept pairs, return the set of concepts for the requested properties * Map data between different terminologies * Declare the capabilities of a terminology service --- ## Development Roadmap The following terminology resources have been tested and are being used in production tooling and now are normative or are expected soon to progress to normative: * [ValueSet](https://hl7.org/fhir/R4/valueset.html) - Normative * [CodeSystem](https://hl7.org/fhir/R4/codesystem.html) - Normative * [ConceptMap](https://hl7.org/fhir/R4/conceptmap.html) - Maturity Level 3 Other terminology resources are still in earlier stages of development. We intend to continue to develop and test these resources and advance them through the [Maturity Levels](https://hl7.org/fhir/R4/versions.html#maturity) at Connectathons and elsewhere: * [NamingSystem](https://hl7.org/fhir/R4/namingsystem.html) - Maturity Level 1 * [TerminologyCapabilities](https://hl7.org/fhir/R4/terminologycapabilities.html) - Maturity Level 0 Version: 1.0 ## Servers Sandbox ``` https://api-staging.heydonto.com ``` Production ``` https://api.heydonto.com ``` ## Security ### bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [HeyDonto FHIR R4 API - Terminology](https://docs.heydonto.com/_bundle/apis/fhir/terminology.yaml) ## CodeSystem ### Get FHIR r4 code systems - [GET /site/{siteId}/fhir/code-system](https://docs.heydonto.com/apis/fhir/terminology/codesystem/fhircodesystemcontroller_getcodesystems.md) ### Create FHIR r4 code system - [POST /site/{siteId}/fhir/code-system](https://docs.heydonto.com/apis/fhir/terminology/codesystem/fhircodesystemcontroller_createcodesystem.md) ### Get FHIR r4 code system by ID - [GET /site/{siteId}/fhir/code-system/{id}](https://docs.heydonto.com/apis/fhir/terminology/codesystem/fhircodesystemcontroller_getcodesystem.md) ### Update FHIR r4 code system - [PUT /site/{siteId}/fhir/code-system/{id}](https://docs.heydonto.com/apis/fhir/terminology/codesystem/fhircodesystemcontroller_updatecodesystem.md) ### Delete FHIR r4 code system - [DELETE /site/{siteId}/fhir/code-system/{id}](https://docs.heydonto.com/apis/fhir/terminology/codesystem/fhircodesystemcontroller_deletecodesystem.md) ### Get FHIR r4 code system history by ID - [GET /site/{siteId}/fhir/code-system/{id}/history](https://docs.heydonto.com/apis/fhir/terminology/codesystem/fhircodesystemcontroller_getcodesystemhistory.md) ## ConceptMap ### Get FHIR r4 concept maps - [GET /site/{siteId}/fhir/concept-map](https://docs.heydonto.com/apis/fhir/terminology/conceptmap/fhirconceptmapcontroller_getconceptmaps.md) ### Create FHIR r4 concept map - [POST /site/{siteId}/fhir/concept-map](https://docs.heydonto.com/apis/fhir/terminology/conceptmap/fhirconceptmapcontroller_createconceptmap.md) ### Get FHIR r4 concept map by ID - [GET /site/{siteId}/fhir/concept-map/{id}](https://docs.heydonto.com/apis/fhir/terminology/conceptmap/fhirconceptmapcontroller_getconceptmap.md) ### Update FHIR r4 concept map - [PUT /site/{siteId}/fhir/concept-map/{id}](https://docs.heydonto.com/apis/fhir/terminology/conceptmap/fhirconceptmapcontroller_updateconceptmap.md) ### Delete FHIR r4 concept map - [DELETE /site/{siteId}/fhir/concept-map/{id}](https://docs.heydonto.com/apis/fhir/terminology/conceptmap/fhirconceptmapcontroller_deleteconceptmap.md) ### Get FHIR r4 concept map history by ID - [GET /site/{siteId}/fhir/concept-map/{id}/history](https://docs.heydonto.com/apis/fhir/terminology/conceptmap/fhirconceptmapcontroller_getconceptmaphistory.md) ## NamingSystem ### Get FHIR r4 naming systems - [GET /site/{siteId}/fhir/naming-system](https://docs.heydonto.com/apis/fhir/terminology/namingsystem/fhirnamingsystemcontroller_getnamingsystems.md) ### Create FHIR r4 naming system - [POST /site/{siteId}/fhir/naming-system](https://docs.heydonto.com/apis/fhir/terminology/namingsystem/fhirnamingsystemcontroller_createnamingsystem.md) ### Get FHIR r4 naming system by ID - [GET /site/{siteId}/fhir/naming-system/{id}](https://docs.heydonto.com/apis/fhir/terminology/namingsystem/fhirnamingsystemcontroller_getnamingsystem.md) ### Update FHIR r4 naming system - [PUT /site/{siteId}/fhir/naming-system/{id}](https://docs.heydonto.com/apis/fhir/terminology/namingsystem/fhirnamingsystemcontroller_updatenamingsystem.md) ### Delete FHIR r4 naming system - [DELETE /site/{siteId}/fhir/naming-system/{id}](https://docs.heydonto.com/apis/fhir/terminology/namingsystem/fhirnamingsystemcontroller_deletenamingsystem.md) ### Get FHIR r4 naming system history by ID - [GET /site/{siteId}/fhir/naming-system/{id}/history](https://docs.heydonto.com/apis/fhir/terminology/namingsystem/fhirnamingsystemcontroller_getnamingsystemhistory.md) ## ValueSet ### Get FHIR r4 value sets - [GET /site/{siteId}/fhir/value-set](https://docs.heydonto.com/apis/fhir/terminology/valueset/fhirvaluesetcontroller_getvaluesets.md) ### Create FHIR r4 value set - [POST /site/{siteId}/fhir/value-set](https://docs.heydonto.com/apis/fhir/terminology/valueset/fhirvaluesetcontroller_createvalueset.md) ### Get FHIR r4 value set by ID - [GET /site/{siteId}/fhir/value-set/{id}](https://docs.heydonto.com/apis/fhir/terminology/valueset/fhirvaluesetcontroller_getvalueset.md) ### Update FHIR r4 value set - [PUT /site/{siteId}/fhir/value-set/{id}](https://docs.heydonto.com/apis/fhir/terminology/valueset/fhirvaluesetcontroller_updatevalueset.md) ### Delete FHIR r4 value set - [DELETE /site/{siteId}/fhir/value-set/{id}](https://docs.heydonto.com/apis/fhir/terminology/valueset/fhirvaluesetcontroller_deletevalueset.md) ### Get FHIR r4 value set history by ID - [GET /site/{siteId}/fhir/value-set/{id}/history](https://docs.heydonto.com/apis/fhir/terminology/valueset/fhirvaluesetcontroller_getvaluesethistory.md)