TerminologyCapabilities
FoundationA 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.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| TerminologyCapabilities | 0..* | — | A statement of system capabilities |
| .idΣ | 0..1 | String | 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 Bindinglanguages(preferred) |
| .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 terminology capabilities, represented as a URI (globally unique) |
| .versionΣ | 0..1 | string | Business version of the terminology capabilities |
| .nameΣ | 0..1 | string | Name for this terminology capabilities (computer friendly) |
| .titleΣ | 0..1 | string | Name for this terminology capabilities (human friendly) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .dateΣ | 1..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 terminology capabilities |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Bindingjurisdiction(extensible) |
| .purpose | 0..1 | markdown | Why this terminology capabilities is defined |
| .copyrightΣ | 0..1 | markdown | Use and/or publishing restrictions |
| .kindΣ | 1..1 | code | instance | capability | requirements Bindingcapability-statement-kind(required) |
| .softwareΣ | 0..1 | BackboneElement | Software that is covered by this terminology capability statement |
| .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 |
| .nameΣ | 1..1 | string | A name the software is known by |
| .versionΣ | 0..1 | string | Version covered by this statement |
| .implementationΣ | 0..1 | BackboneElement | If this describes a specific instance |
| .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 |
| .descriptionΣ | 1..1 | string | Describes this specific instance |
| .urlΣ | 0..1 | url | Base URL for the implementation |
| .lockedDateΣ | 0..1 | boolean | Whether lockedDate is supported |
| .codeSystem | 0..* | BackboneElement | A code system supported by the server |
| .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 |
| .uri | 0..1 | canonical | URI for the Code System |
| .version | 0..* | BackboneElement | Version of Code System supported |
| .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 | string | Version identifier for this version |
| .isDefaultΣ | 0..1 | boolean | If this is the default version for this code system |
| .compositional | 0..1 | boolean | If compositional grammar is supported |
| .language | 0..* | code | Language Displays supported |
| .filter | 0..* | BackboneElement | Filter Properties supported |
| .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 | 1..1 | code | Code of the property supported |
| .op | 1..* | code | Operations supported for the property |
| .property | 0..* | code | Properties supported for $lookup |
| .subsumption | 0..1 | boolean | Whether subsumption is supported |
| .expansion | 0..1 | BackboneElement | Information about the [ValueSet/$expand](valueset-operation-expand.html) operation |
| .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 |
| .hierarchical | 0..1 | boolean | Whether the server can return nested value sets |
| .paging | 0..1 | boolean | Whether the server supports paging on expansion |
| .incomplete | 0..1 | boolean | Allow request for incomplete expansions? |
| .parameter | 0..* | BackboneElement | Supported expansion parameter |
| .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 |
| .name | 1..1 | code | Expansion Parameter name |
| .documentation | 0..1 | string | Description of support for parameter |
| .textFilter | 0..1 | markdown | Documentation about text searching works |
| .codeSearch | 0..1 | code | explicit | all Bindingcode-search-support(required) |
| .validateCode | 0..1 | BackboneElement | Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation |
| .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 |
| .translations | 1..1 | boolean | Whether translations are validated |
| .translation | 0..1 | BackboneElement | Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation |
| .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 |
| .needsMap | 1..1 | boolean | Whether the client must identify the map |
| .closure | 0..1 | BackboneElement | Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation |
| .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 |
| .translation | 0..1 | boolean | If cross-system closure is supported |