Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

4.12 Resource TerminologyCapabilities - Content

Vocabulary Work GroupMaturity Level: 0 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

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.

4.12.1 Scope and Usage

The TerminologyCapabilities resource provides for a terminology server to describe how the underlying terminology service works.

A client can get the TerminologyCapabilities statement for a Terminology Service by using the capabilities API: 

 GET [base]/metadata?mode=terminology

This will return the TerminologyCapabilities resource that applies to the service itself.

4.12.2 Boundaries and Relationships

  • The TerminologyCapabilities resource does not describe the API - see CapabilityStatement for this.
  • The CodeSystem resource documents the inherent structure and capabilities of code system, whereas the TerminologyCapabilities resource documents what a server hosting the code system is capable of

4.12.3 References

No resources refer to this resource directly.

This resource does not implement any patterns.

4.12.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities TUCanonicalResourceA statement of system capabilities
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A Capability Statement SHALL have at least one of description, software, or implementation element.
+ Rule: If kind = instance, implementation must be present and software may be present
+ Rule: If kind = capability, implementation must be absent, software must be present
+ Rule: If kind = requirements, implementation and software must be absent
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright
... url Σ0..1uriCanonical identifier for this terminology capabilities, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the terminology capabilities
... name ΣI0..1stringName for this terminology capabilities (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the terminology capabilities
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this terminology capabilities is defined
... copyright Σ0..1markdownUse and/or publishing restrictions
... kind ΣI1..1codeinstance | capability | requirements
CapabilityStatementKind (Required)
... software ΣI0..1BackboneElementSoftware that is covered by this terminology capability statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
... implementation ΣI0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1urlBase URL for the implementation
... lockedDate Σ0..1booleanWhether lockedDate is supported
... codeSystem I0..*BackboneElementA code system supported by the server
+ Rule: If there is more than one version, a version code must be defined
.... uri 0..1canonical(CodeSystem)URI for the Code System
.... version 0..*BackboneElementVersion of Code System supported
..... code ΣI0..1stringVersion identifier for this version
..... isDefault Σ0..1booleanIf this is the default version for this code system
..... compositional 0..1booleanIf compositional grammar is supported
..... language 0..*codeLanguage Displays supported
..... filter 0..*BackboneElementFilter Properties supported
...... code 1..1codeCode of the property supported
...... op 1..*codeOperations supported for the property
..... property 0..*codeProperties supported for $lookup
.... subsumption 0..1booleanWhether subsumption is supported
... expansion 0..1BackboneElementInformation about the [ValueSet/$expand](valueset-operation-expand.html) operation
.... hierarchical 0..1booleanWhether the server can return nested value sets
.... paging 0..1booleanWhether the server supports paging on expansion
.... incomplete 0..1booleanAllow request for incomplete expansions?
.... parameter 0..*BackboneElementSupported expansion parameter
..... name 1..1codeExpansion Parameter name
..... documentation 0..1stringDescription of support for parameter
.... textFilter 0..1markdownDocumentation about text searching works
... codeSearch 0..1codeexplicit | all
CodeSearchSupport (Required)
... validateCode 0..1BackboneElementInformation about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
.... translations 1..1booleanWhether translations are validated
... translation 0..1BackboneElementInformation about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
.... needsMap 1..1booleanWhether the client must identify the map
... closure 0..1BackboneElementInformation about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
.... translation 0..1booleanIf cross-system closure is supported

doco Documentation for this format

UML Diagram (Legend)

TerminologyCapabilities (CanonicalResource)An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different serversurl : uri [0..1]The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities 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 sequenceversion : string [0..1]A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the terminology capabilitiestitle : string [0..1]The status of this terminology capabilities. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the terminology capabilities was published. The date must change 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 terminology capabilities changesdate : dateTime [1..1]The name of the organization or individual that published the terminology capabilitiespublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFPdescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instancesuseContext : UsageContext [0..*]A legal or geographic region in which the terminology capabilities is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this terminology capabilities is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilitiescopyright : markdown [0..1]The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase)kind : code [1..1] « How a capability statement is intended to be used. (Strength=Required)CapabilityStatementKind! »Whether the server supports lockedDatelockedDate : boolean [0..1]The degree to which the server supports the code search parameter on ValueSet, if it is supportedcodeSearch : code [0..1] « The degree to which the server supports the code search parameter on ValueSet, if it is supported. (Strength=Required)CodeSearchSupport! »SoftwareName the software is known byname : string [1..1]The version identifier for the software covered by this statementversion : string [0..1]ImplementationInformation about the specific installation that this terminology capability statement relates todescription : string [1..1]An absolute base URL for the implementationurl : url [0..1]CodeSystemURI for the Code Systemuri : canonical [0..1] « CodeSystem »True if subsumption is supported for this version of the code systemsubsumption : boolean [0..1]VersionFor version-less code systems, there should be a single version with no identifiercode : string [0..1]If this is the default version for this code systemisDefault : boolean [0..1]If the compositional grammar defined by the code system is supportedcompositional : boolean [0..1]Language Displays supportedlanguage : code [0..*]Properties supported for $lookupproperty : code [0..*]FilterCode of the property supportedcode : code [1..1]Operations supported for the propertyop : code [1..*]ExpansionWhether the server can return nested value setshierarchical : boolean [0..1]Whether the server supports paging on expansionpaging : boolean [0..1]Allow request for incomplete expansions?incomplete : boolean [0..1]Documentation about text searching workstextFilter : markdown [0..1]ParameterExpansion Parameter namename : code [1..1]Description of support for parameterdocumentation : string [0..1]ValidateCodeWhether translations are validatedtranslations : boolean [1..1]TranslationWhether the client must identify the mapneedsMap : boolean [1..1]ClosureIf cross-system closure is supportedtranslation : boolean [0..1]Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installationsoftware[0..1]Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software programimplementation[0..1]Filter Properties supportedfilter[0..*]For the code system, a list of versions that are supported by the serverversion[0..*]Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resourcecodeSystem[0..*]Supported expansion parameterparameter[0..*]Information about the [ValueSet/$expand](valueset-operation-expand.html) operationexpansion[0..1]Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operationvalidateCode[0..1]Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operationtranslation[0..1]Whether the $closure operation is supportedclosure[0..1]

XML Template

<TerminologyCapabilities xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this terminology capabilities, represented as a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the terminology capabilities -->
 <name value="[string]"/><!-- ?? 0..1 Name for this terminology capabilities (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this terminology capabilities (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the terminology capabilities -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for terminology capabilities (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this terminology capabilities is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <kind value="[code]"/><!-- ?? 1..1 instance | capability | requirements -->
 <software>  <!-- ?? 0..1 Software that is covered by this terminology capability statement -->
  <name value="[string]"/><!-- 1..1 A name the software is known by -->
  <version value="[string]"/><!-- 0..1 Version covered by this statement -->
 </software>
 <implementation>  <!-- ?? 0..1 If this describes a specific instance -->
  <description value="[string]"/><!-- 1..1 Describes this specific instance -->
  <url value="[url]"/><!-- 0..1 Base URL for the implementation -->
 </implementation>
 <lockedDate value="[boolean]"/><!-- 0..1 Whether lockedDate is supported -->
 <codeSystem>  <!-- 0..* A code system supported by the server -->
  <uri><!-- 0..1 canonical(CodeSystem) URI for the Code System --></uri>
  <version>  <!-- 0..* Version of Code System supported -->
   <code value="[string]"/><!-- ?? 0..1 Version identifier for this version -->
   <isDefault value="[boolean]"/><!-- 0..1 If this is the default version for this code system -->
   <compositional value="[boolean]"/><!-- 0..1 If compositional grammar is supported -->
   <language value="[code]"/><!-- 0..* Language Displays supported -->
   <filter>  <!-- 0..* Filter Properties supported -->
    <code value="[code]"/><!-- 1..1 Code of the property supported -->
    <op value="[code]"/><!-- 1..* Operations supported for the property -->
   </filter>
   <property value="[code]"/><!-- 0..* Properties supported for $lookup -->
  </version>
  <subsumption value="[boolean]"/><!-- 0..1 Whether subsumption is supported -->
 </codeSystem>
 <expansion>  <!-- 0..1 Information about the [ValueSet/$expand](valueset-operation-expand.html) operation -->
  <hierarchical value="[boolean]"/><!-- 0..1 Whether the server can return nested value sets -->
  <paging value="[boolean]"/><!-- 0..1 Whether the server supports paging on expansion -->
  <incomplete value="[boolean]"/><!-- 0..1 Allow request for incomplete expansions? -->
  <parameter>  <!-- 0..* Supported expansion parameter -->
   <name value="[code]"/><!-- 1..1 Expansion Parameter name -->
   <documentation value="[string]"/><!-- 0..1 Description of support for parameter -->
  </parameter>
  <textFilter value="[markdown]"/><!-- 0..1 Documentation about text searching works -->
 </expansion>
 <codeSearch value="[code]"/><!-- 0..1 explicit | all -->
 <validateCode>  <!-- 0..1 Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation -->
  <translations value="[boolean]"/><!-- 1..1 Whether translations are validated -->
 </validateCode>
 <translation>  <!-- 0..1 Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation -->
  <needsMap value="[boolean]"/><!-- 1..1 Whether the client must identify the map -->
 </translation>
 <closure>  <!-- 0..1 Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation -->
  <translation value="[boolean]"/><!-- 0..1 If cross-system closure is supported -->
 </closure>
</TerminologyCapabilities>

JSON Template

{doco
  "resourceType" : "TerminologyCapabilities",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the terminology capabilities
  "name" : "<string>", // C? Name for this terminology capabilities (computer friendly)
  "title" : "<string>", // Name for this terminology capabilities (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the terminology capabilities
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for terminology capabilities (if applicable)
  "purpose" : "<markdown>", // Why this terminology capabilities is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "kind" : "<code>", // C? R!  instance | capability | requirements
  "software" : { // C? Software that is covered by this terminology capability statement
    "name" : "<string>", // R!  A name the software is known by
    "version" : "<string>" // Version covered by this statement
  },
  "implementation" : { // C? If this describes a specific instance
    "description" : "<string>", // R!  Describes this specific instance
    "url" : "<url>" // Base URL for the implementation
  },
  "lockedDate" : <boolean>, // Whether lockedDate is supported
  "codeSystem" : [{ // A code system supported by the server
    "uri" : { canonical(CodeSystem) }, // URI for the Code System
    "version" : [{ // Version of Code System supported
      "code" : "<string>", // C? Version identifier for this version
      "isDefault" : <boolean>, // If this is the default version for this code system
      "compositional" : <boolean>, // If compositional grammar is supported
      "language" : ["<code>"], // Language Displays supported
      "filter" : [{ // Filter Properties supported
        "code" : "<code>", // R!  Code of the property supported
        "op" : ["<code>"] // R!  Operations supported for the property
      }],
      "property" : ["<code>"] // Properties supported for $lookup
    }],
    "subsumption" : <boolean> // Whether subsumption is supported
  }],
  "expansion" : { // Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
    "hierarchical" : <boolean>, // Whether the server can return nested value sets
    "paging" : <boolean>, // Whether the server supports paging on expansion
    "incomplete" : <boolean>, // Allow request for incomplete expansions?
    "parameter" : [{ // Supported expansion parameter
      "name" : "<code>", // R!  Expansion Parameter name
      "documentation" : "<string>" // Description of support for parameter
    }],
    "textFilter" : "<markdown>" // Documentation about text searching works
  },
  "codeSearch" : "<code>", // explicit | all
  "validateCode" : { // Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
    "translations" : <boolean> // R!  Whether translations are validated
  },
  "translation" : { // Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
    "needsMap" : <boolean> // R!  Whether the client must identify the map
  },
  "closure" : { // Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
    "translation" : <boolean> // If cross-system closure is supported
  }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:TerminologyCapabilities;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:TerminologyCapabilities.url [ uri ]; # 0..1 Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
  fhir:TerminologyCapabilities.version [ string ]; # 0..1 Business version of the terminology capabilities
  fhir:TerminologyCapabilities.name [ string ]; # 0..1 Name for this terminology capabilities (computer friendly)
  fhir:TerminologyCapabilities.title [ string ]; # 0..1 Name for this terminology capabilities (human friendly)
  fhir:TerminologyCapabilities.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:TerminologyCapabilities.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:TerminologyCapabilities.date [ dateTime ]; # 1..1 Date last changed
  fhir:TerminologyCapabilities.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:TerminologyCapabilities.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:TerminologyCapabilities.description [ markdown ]; # 0..1 Natural language description of the terminology capabilities
  fhir:TerminologyCapabilities.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:TerminologyCapabilities.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for terminology capabilities (if applicable)
  fhir:TerminologyCapabilities.purpose [ markdown ]; # 0..1 Why this terminology capabilities is defined
  fhir:TerminologyCapabilities.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:TerminologyCapabilities.kind [ code ]; # 1..1 instance | capability | requirements
  fhir:TerminologyCapabilities.software [ # 0..1 Software that is covered by this terminology capability statement
    fhir:TerminologyCapabilities.software.name [ string ]; # 1..1 A name the software is known by
    fhir:TerminologyCapabilities.software.version [ string ]; # 0..1 Version covered by this statement
  ];
  fhir:TerminologyCapabilities.implementation [ # 0..1 If this describes a specific instance
    fhir:TerminologyCapabilities.implementation.description [ string ]; # 1..1 Describes this specific instance
    fhir:TerminologyCapabilities.implementation.url [ url ]; # 0..1 Base URL for the implementation
  ];
  fhir:TerminologyCapabilities.lockedDate [ boolean ]; # 0..1 Whether lockedDate is supported
  fhir:TerminologyCapabilities.codeSystem [ # 0..* A code system supported by the server
    fhir:TerminologyCapabilities.codeSystem.uri [ canonical(CodeSystem) ]; # 0..1 URI for the Code System
    fhir:TerminologyCapabilities.codeSystem.version [ # 0..* Version of Code System supported
      fhir:TerminologyCapabilities.codeSystem.version.code [ string ]; # 0..1 Version identifier for this version
      fhir:TerminologyCapabilities.codeSystem.version.isDefault [ boolean ]; # 0..1 If this is the default version for this code system
      fhir:TerminologyCapabilities.codeSystem.version.compositional [ boolean ]; # 0..1 If compositional grammar is supported
      fhir:TerminologyCapabilities.codeSystem.version.language [ code ], ... ; # 0..* Language Displays supported
      fhir:TerminologyCapabilities.codeSystem.version.filter [ # 0..* Filter Properties supported
        fhir:TerminologyCapabilities.codeSystem.version.filter.code [ code ]; # 1..1 Code of the property supported
        fhir:TerminologyCapabilities.codeSystem.version.filter.op [ code ], ... ; # 1..* Operations supported for the property
      ], ...;
      fhir:TerminologyCapabilities.codeSystem.version.property [ code ], ... ; # 0..* Properties supported for $lookup
    ], ...;
    fhir:TerminologyCapabilities.codeSystem.subsumption [ boolean ]; # 0..1 Whether subsumption is supported
  ], ...;
  fhir:TerminologyCapabilities.expansion [ # 0..1 Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
    fhir:TerminologyCapabilities.expansion.hierarchical [ boolean ]; # 0..1 Whether the server can return nested value sets
    fhir:TerminologyCapabilities.expansion.paging [ boolean ]; # 0..1 Whether the server supports paging on expansion
    fhir:TerminologyCapabilities.expansion.incomplete [ boolean ]; # 0..1 Allow request for incomplete expansions?
    fhir:TerminologyCapabilities.expansion.parameter [ # 0..* Supported expansion parameter
      fhir:TerminologyCapabilities.expansion.parameter.name [ code ]; # 1..1 Expansion Parameter name
      fhir:TerminologyCapabilities.expansion.parameter.documentation [ string ]; # 0..1 Description of support for parameter
    ], ...;
    fhir:TerminologyCapabilities.expansion.textFilter [ markdown ]; # 0..1 Documentation about text searching works
  ];
  fhir:TerminologyCapabilities.codeSearch [ code ]; # 0..1 explicit | all
  fhir:TerminologyCapabilities.validateCode [ # 0..1 Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
    fhir:TerminologyCapabilities.validateCode.translations [ boolean ]; # 1..1 Whether translations are validated
  ];
  fhir:TerminologyCapabilities.translation [ # 0..1 Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
    fhir:TerminologyCapabilities.translation.needsMap [ boolean ]; # 1..1 Whether the client must identify the map
  ];
  fhir:TerminologyCapabilities.closure [ # 0..1 Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
    fhir:TerminologyCapabilities.closure.translation [ boolean ]; # 0..1 If cross-system closure is supported
  ];
]

Changes since R3

TerminologyCapabilities
TerminologyCapabilities.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.2.0
TerminologyCapabilities.kind
  • Change value set from http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.0 to http://hl7.org/fhir/ValueSet/capability-statement-kind|4.2.0
TerminologyCapabilities.codeSearch
  • Change value set from http://hl7.org/fhir/ValueSet/code-search-support|4.0.0 to http://hl7.org/fhir/ValueSet/code-search-support|4.2.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = Not Mapped)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities TUCanonicalResourceA statement of system capabilities
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A Capability Statement SHALL have at least one of description, software, or implementation element.
+ Rule: If kind = instance, implementation must be present and software may be present
+ Rule: If kind = capability, implementation must be absent, software must be present
+ Rule: If kind = requirements, implementation and software must be absent
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright
... url Σ0..1uriCanonical identifier for this terminology capabilities, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the terminology capabilities
... name ΣI0..1stringName for this terminology capabilities (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the terminology capabilities
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this terminology capabilities is defined
... copyright Σ0..1markdownUse and/or publishing restrictions
... kind ΣI1..1codeinstance | capability | requirements
CapabilityStatementKind (Required)
... software ΣI0..1BackboneElementSoftware that is covered by this terminology capability statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
... implementation ΣI0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1urlBase URL for the implementation
... lockedDate Σ0..1booleanWhether lockedDate is supported
... codeSystem I0..*BackboneElementA code system supported by the server
+ Rule: If there is more than one version, a version code must be defined
.... uri 0..1canonical(CodeSystem)URI for the Code System
.... version 0..*BackboneElementVersion of Code System supported
..... code ΣI0..1stringVersion identifier for this version
..... isDefault Σ0..1booleanIf this is the default version for this code system
..... compositional 0..1booleanIf compositional grammar is supported
..... language 0..*codeLanguage Displays supported
..... filter 0..*BackboneElementFilter Properties supported
...... code 1..1codeCode of the property supported
...... op 1..*codeOperations supported for the property
..... property 0..*codeProperties supported for $lookup
.... subsumption 0..1booleanWhether subsumption is supported
... expansion 0..1BackboneElementInformation about the [ValueSet/$expand](valueset-operation-expand.html) operation
.... hierarchical 0..1booleanWhether the server can return nested value sets
.... paging 0..1booleanWhether the server supports paging on expansion
.... incomplete 0..1booleanAllow request for incomplete expansions?
.... parameter 0..*BackboneElementSupported expansion parameter
..... name 1..1codeExpansion Parameter name
..... documentation 0..1stringDescription of support for parameter
.... textFilter 0..1markdownDocumentation about text searching works
... codeSearch 0..1codeexplicit | all
CodeSearchSupport (Required)
... validateCode 0..1BackboneElementInformation about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
.... translations 1..1booleanWhether translations are validated
... translation 0..1BackboneElementInformation about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
.... needsMap 1..1booleanWhether the client must identify the map
... closure 0..1BackboneElementInformation about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
.... translation 0..1booleanIf cross-system closure is supported

doco Documentation for this format

UML Diagram (Legend)

TerminologyCapabilities (CanonicalResource)An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different serversurl : uri [0..1]The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities 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 sequenceversion : string [0..1]A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the terminology capabilitiestitle : string [0..1]The status of this terminology capabilities. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the terminology capabilities was published. The date must change 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 terminology capabilities changesdate : dateTime [1..1]The name of the organization or individual that published the terminology capabilitiespublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFPdescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instancesuseContext : UsageContext [0..*]A legal or geographic region in which the terminology capabilities is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this terminology capabilities is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilitiescopyright : markdown [0..1]The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase)kind : code [1..1] « How a capability statement is intended to be used. (Strength=Required)CapabilityStatementKind! »Whether the server supports lockedDatelockedDate : boolean [0..1]The degree to which the server supports the code search parameter on ValueSet, if it is supportedcodeSearch : code [0..1] « The degree to which the server supports the code search parameter on ValueSet, if it is supported. (Strength=Required)CodeSearchSupport! »SoftwareName the software is known byname : string [1..1]The version identifier for the software covered by this statementversion : string [0..1]ImplementationInformation about the specific installation that this terminology capability statement relates todescription : string [1..1]An absolute base URL for the implementationurl : url [0..1]CodeSystemURI for the Code Systemuri : canonical [0..1] « CodeSystem »True if subsumption is supported for this version of the code systemsubsumption : boolean [0..1]VersionFor version-less code systems, there should be a single version with no identifiercode : string [0..1]If this is the default version for this code systemisDefault : boolean [0..1]If the compositional grammar defined by the code system is supportedcompositional : boolean [0..1]Language Displays supportedlanguage : code [0..*]Properties supported for $lookupproperty : code [0..*]FilterCode of the property supportedcode : code [1..1]Operations supported for the propertyop : code [1..*]ExpansionWhether the server can return nested value setshierarchical : boolean [0..1]Whether the server supports paging on expansionpaging : boolean [0..1]Allow request for incomplete expansions?incomplete : boolean [0..1]Documentation about text searching workstextFilter : markdown [0..1]ParameterExpansion Parameter namename : code [1..1]Description of support for parameterdocumentation : string [0..1]ValidateCodeWhether translations are validatedtranslations : boolean [1..1]TranslationWhether the client must identify the mapneedsMap : boolean [1..1]ClosureIf cross-system closure is supportedtranslation : boolean [0..1]Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installationsoftware[0..1]Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software programimplementation[0..1]Filter Properties supportedfilter[0..*]For the code system, a list of versions that are supported by the serverversion[0..*]Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resourcecodeSystem[0..*]Supported expansion parameterparameter[0..*]Information about the [ValueSet/$expand](valueset-operation-expand.html) operationexpansion[0..1]Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operationvalidateCode[0..1]Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operationtranslation[0..1]Whether the $closure operation is supportedclosure[0..1]

XML Template

<TerminologyCapabilities xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this terminology capabilities, represented as a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the terminology capabilities -->
 <name value="[string]"/><!-- ?? 0..1 Name for this terminology capabilities (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this terminology capabilities (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the terminology capabilities -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for terminology capabilities (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this terminology capabilities is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <kind value="[code]"/><!-- ?? 1..1 instance | capability | requirements -->
 <software>  <!-- ?? 0..1 Software that is covered by this terminology capability statement -->
  <name value="[string]"/><!-- 1..1 A name the software is known by -->
  <version value="[string]"/><!-- 0..1 Version covered by this statement -->
 </software>
 <implementation>  <!-- ?? 0..1 If this describes a specific instance -->
  <description value="[string]"/><!-- 1..1 Describes this specific instance -->
  <url value="[url]"/><!-- 0..1 Base URL for the implementation -->
 </implementation>
 <lockedDate value="[boolean]"/><!-- 0..1 Whether lockedDate is supported -->
 <codeSystem>  <!-- 0..* A code system supported by the server -->
  <uri><!-- 0..1 canonical(CodeSystem) URI for the Code System --></uri>
  <version>  <!-- 0..* Version of Code System supported -->
   <code value="[string]"/><!-- ?? 0..1 Version identifier for this version -->
   <isDefault value="[boolean]"/><!-- 0..1 If this is the default version for this code system -->
   <compositional value="[boolean]"/><!-- 0..1 If compositional grammar is supported -->
   <language value="[code]"/><!-- 0..* Language Displays supported -->
   <filter>  <!-- 0..* Filter Properties supported -->
    <code value="[code]"/><!-- 1..1 Code of the property supported -->
    <op value="[code]"/><!-- 1..* Operations supported for the property -->
   </filter>
   <property value="[code]"/><!-- 0..* Properties supported for $lookup -->
  </version>
  <subsumption value="[boolean]"/><!-- 0..1 Whether subsumption is supported -->
 </codeSystem>
 <expansion>  <!-- 0..1 Information about the [ValueSet/$expand](valueset-operation-expand.html) operation -->
  <hierarchical value="[boolean]"/><!-- 0..1 Whether the server can return nested value sets -->
  <paging value="[boolean]"/><!-- 0..1 Whether the server supports paging on expansion -->
  <incomplete value="[boolean]"/><!-- 0..1 Allow request for incomplete expansions? -->
  <parameter>  <!-- 0..* Supported expansion parameter -->
   <name value="[code]"/><!-- 1..1 Expansion Parameter name -->
   <documentation value="[string]"/><!-- 0..1 Description of support for parameter -->
  </parameter>
  <textFilter value="[markdown]"/><!-- 0..1 Documentation about text searching works -->
 </expansion>
 <codeSearch value="[code]"/><!-- 0..1 explicit | all -->
 <validateCode>  <!-- 0..1 Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation -->
  <translations value="[boolean]"/><!-- 1..1 Whether translations are validated -->
 </validateCode>
 <translation>  <!-- 0..1 Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation -->
  <needsMap value="[boolean]"/><!-- 1..1 Whether the client must identify the map -->
 </translation>
 <closure>  <!-- 0..1 Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation -->
  <translation value="[boolean]"/><!-- 0..1 If cross-system closure is supported -->
 </closure>
</TerminologyCapabilities>

JSON Template

{doco
  "resourceType" : "TerminologyCapabilities",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the terminology capabilities
  "name" : "<string>", // C? Name for this terminology capabilities (computer friendly)
  "title" : "<string>", // Name for this terminology capabilities (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the terminology capabilities
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for terminology capabilities (if applicable)
  "purpose" : "<markdown>", // Why this terminology capabilities is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "kind" : "<code>", // C? R!  instance | capability | requirements
  "software" : { // C? Software that is covered by this terminology capability statement
    "name" : "<string>", // R!  A name the software is known by
    "version" : "<string>" // Version covered by this statement
  },
  "implementation" : { // C? If this describes a specific instance
    "description" : "<string>", // R!  Describes this specific instance
    "url" : "<url>" // Base URL for the implementation
  },
  "lockedDate" : <boolean>, // Whether lockedDate is supported
  "codeSystem" : [{ // A code system supported by the server
    "uri" : { canonical(CodeSystem) }, // URI for the Code System
    "version" : [{ // Version of Code System supported
      "code" : "<string>", // C? Version identifier for this version
      "isDefault" : <boolean>, // If this is the default version for this code system
      "compositional" : <boolean>, // If compositional grammar is supported
      "language" : ["<code>"], // Language Displays supported
      "filter" : [{ // Filter Properties supported
        "code" : "<code>", // R!  Code of the property supported
        "op" : ["<code>"] // R!  Operations supported for the property
      }],
      "property" : ["<code>"] // Properties supported for $lookup
    }],
    "subsumption" : <boolean> // Whether subsumption is supported
  }],
  "expansion" : { // Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
    "hierarchical" : <boolean>, // Whether the server can return nested value sets
    "paging" : <boolean>, // Whether the server supports paging on expansion
    "incomplete" : <boolean>, // Allow request for incomplete expansions?
    "parameter" : [{ // Supported expansion parameter
      "name" : "<code>", // R!  Expansion Parameter name
      "documentation" : "<string>" // Description of support for parameter
    }],
    "textFilter" : "<markdown>" // Documentation about text searching works
  },
  "codeSearch" : "<code>", // explicit | all
  "validateCode" : { // Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
    "translations" : <boolean> // R!  Whether translations are validated
  },
  "translation" : { // Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
    "needsMap" : <boolean> // R!  Whether the client must identify the map
  },
  "closure" : { // Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
    "translation" : <boolean> // If cross-system closure is supported
  }
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:TerminologyCapabilities;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:TerminologyCapabilities.url [ uri ]; # 0..1 Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
  fhir:TerminologyCapabilities.version [ string ]; # 0..1 Business version of the terminology capabilities
  fhir:TerminologyCapabilities.name [ string ]; # 0..1 Name for this terminology capabilities (computer friendly)
  fhir:TerminologyCapabilities.title [ string ]; # 0..1 Name for this terminology capabilities (human friendly)
  fhir:TerminologyCapabilities.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:TerminologyCapabilities.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:TerminologyCapabilities.date [ dateTime ]; # 1..1 Date last changed
  fhir:TerminologyCapabilities.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:TerminologyCapabilities.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:TerminologyCapabilities.description [ markdown ]; # 0..1 Natural language description of the terminology capabilities
  fhir:TerminologyCapabilities.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:TerminologyCapabilities.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for terminology capabilities (if applicable)
  fhir:TerminologyCapabilities.purpose [ markdown ]; # 0..1 Why this terminology capabilities is defined
  fhir:TerminologyCapabilities.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:TerminologyCapabilities.kind [ code ]; # 1..1 instance | capability | requirements
  fhir:TerminologyCapabilities.software [ # 0..1 Software that is covered by this terminology capability statement
    fhir:TerminologyCapabilities.software.name [ string ]; # 1..1 A name the software is known by
    fhir:TerminologyCapabilities.software.version [ string ]; # 0..1 Version covered by this statement
  ];
  fhir:TerminologyCapabilities.implementation [ # 0..1 If this describes a specific instance
    fhir:TerminologyCapabilities.implementation.description [ string ]; # 1..1 Describes this specific instance
    fhir:TerminologyCapabilities.implementation.url [ url ]; # 0..1 Base URL for the implementation
  ];
  fhir:TerminologyCapabilities.lockedDate [ boolean ]; # 0..1 Whether lockedDate is supported
  fhir:TerminologyCapabilities.codeSystem [ # 0..* A code system supported by the server
    fhir:TerminologyCapabilities.codeSystem.uri [ canonical(CodeSystem) ]; # 0..1 URI for the Code System
    fhir:TerminologyCapabilities.codeSystem.version [ # 0..* Version of Code System supported
      fhir:TerminologyCapabilities.codeSystem.version.code [ string ]; # 0..1 Version identifier for this version
      fhir:TerminologyCapabilities.codeSystem.version.isDefault [ boolean ]; # 0..1 If this is the default version for this code system
      fhir:TerminologyCapabilities.codeSystem.version.compositional [ boolean ]; # 0..1 If compositional grammar is supported
      fhir:TerminologyCapabilities.codeSystem.version.language [ code ], ... ; # 0..* Language Displays supported
      fhir:TerminologyCapabilities.codeSystem.version.filter [ # 0..* Filter Properties supported
        fhir:TerminologyCapabilities.codeSystem.version.filter.code [ code ]; # 1..1 Code of the property supported
        fhir:TerminologyCapabilities.codeSystem.version.filter.op [ code ], ... ; # 1..* Operations supported for the property
      ], ...;
      fhir:TerminologyCapabilities.codeSystem.version.property [ code ], ... ; # 0..* Properties supported for $lookup
    ], ...;
    fhir:TerminologyCapabilities.codeSystem.subsumption [ boolean ]; # 0..1 Whether subsumption is supported
  ], ...;
  fhir:TerminologyCapabilities.expansion [ # 0..1 Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
    fhir:TerminologyCapabilities.expansion.hierarchical [ boolean ]; # 0..1 Whether the server can return nested value sets
    fhir:TerminologyCapabilities.expansion.paging [ boolean ]; # 0..1 Whether the server supports paging on expansion
    fhir:TerminologyCapabilities.expansion.incomplete [ boolean ]; # 0..1 Allow request for incomplete expansions?
    fhir:TerminologyCapabilities.expansion.parameter [ # 0..* Supported expansion parameter
      fhir:TerminologyCapabilities.expansion.parameter.name [ code ]; # 1..1 Expansion Parameter name
      fhir:TerminologyCapabilities.expansion.parameter.documentation [ string ]; # 0..1 Description of support for parameter
    ], ...;
    fhir:TerminologyCapabilities.expansion.textFilter [ markdown ]; # 0..1 Documentation about text searching works
  ];
  fhir:TerminologyCapabilities.codeSearch [ code ]; # 0..1 explicit | all
  fhir:TerminologyCapabilities.validateCode [ # 0..1 Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
    fhir:TerminologyCapabilities.validateCode.translations [ boolean ]; # 1..1 Whether translations are validated
  ];
  fhir:TerminologyCapabilities.translation [ # 0..1 Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
    fhir:TerminologyCapabilities.translation.needsMap [ boolean ]; # 1..1 Whether the client must identify the map
  ];
  fhir:TerminologyCapabilities.closure [ # 0..1 Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
    fhir:TerminologyCapabilities.closure.translation [ boolean ]; # 0..1 If cross-system closure is supported
  ];
]

Changes since Release 3

TerminologyCapabilities
TerminologyCapabilities.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.2.0
TerminologyCapabilities.kind
  • Change value set from http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.0 to http://hl7.org/fhir/ValueSet/capability-statement-kind|4.2.0
TerminologyCapabilities.codeSearch
  • Change value set from http://hl7.org/fhir/ValueSet/code-search-support|4.0.0 to http://hl7.org/fhir/ValueSet/code-search-support|4.2.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = Not Mapped)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a

4.12.4.1 Terminology Bindings

PathDefinitionTypeReference
TerminologyCapabilities.status The lifecycle status of an artifact.RequiredPublicationStatus
TerminologyCapabilities.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
TerminologyCapabilities.kind How a capability statement is intended to be used.RequiredCapabilityStatementKind
TerminologyCapabilities.codeSearch The degree to which the server supports the code search parameter on ValueSet, if it is supported.RequiredCodeSearchSupport

4.12.4.2 Constraints

idLevelLocationDescriptionExpression
cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
tcp-1Rule TerminologyCapabilities.codeSystemIf there is more than one version, a version code must be definedversion.count() > 1 implies version.all(code.exists())
tcp-2Rule (base)A Capability Statement SHALL have at least one of description, software, or implementation element.(description.count() + software.count() + implementation.count()) > 0
tcp-3Rule (base)If kind = instance, implementation must be present and software may be present(kind != 'instance') or implementation.exists()
tcp-4Rule (base)If kind = capability, implementation must be absent, software must be present(kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5Rule (base)If kind = requirements, implementation and software must be absent(kind!='requirements') or (implementation.exists().not() and software.exists().not())

4.12.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the terminology capabilities(TerminologyCapabilities.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the terminology capabilities(TerminologyCapabilities.useContext.value as Quantity) | (TerminologyCapabilities.useContext.value as Range)
context-typetokenA type of use context assigned to the terminology capabilitiesTerminologyCapabilities.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the terminology capabilitiesOn TerminologyCapabilities.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the terminology capabilitiesOn TerminologyCapabilities.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date NdateThe terminology capabilities publication dateTerminologyCapabilities.date
description NstringThe description of the terminology capabilitiesTerminologyCapabilities.description
jurisdictiontokenIntended jurisdiction for the terminology capabilitiesTerminologyCapabilities.jurisdiction
name NstringComputationally friendly name of the terminology capabilitiesTerminologyCapabilities.name
publisher NstringName of the publisher of the terminology capabilitiesTerminologyCapabilities.publisher
status NtokenThe current status of the terminology capabilitiesTerminologyCapabilities.status
title NstringThe human-friendly name of the terminology capabilitiesTerminologyCapabilities.title
url NuriThe uri that identifies the terminology capabilitiesTerminologyCapabilities.url
version NtokenThe business version of the terminology capabilitiesTerminologyCapabilities.version