Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot
This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableterminologycapabilities | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: CRMIPublishableTerminologyCapabilities | ||
Supports declaration of the TerminologyCapabilities metadata required by HL7 and other organizations that share and publish terminology capabilities with a focus on the aspects of that metadata that are important for post-publication activities including distribution, inclusion in repositories, consumption, and implementation.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CRMIShareableTerminologyCapabilities
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  TerminologyCapabilities | C | 1..1 | CRMIShareableTerminologyCapabilities | A statement of system capabilities |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact |
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact |
| identifier | S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) |
| version | SΣ | 1..1 | string | Business version of the terminology capabilities |
| name | SΣC | 0..1 | string | Name for this terminology capabilities (computer friendly) |
| title | SΣ | 1..1 | string | Name for this terminology capabilities (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
 contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 1..1 | markdown | Natural language description of the terminology capabilities |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | S | 0..1 | markdown | Why this terminology capabilities is defined |
| copyright | SΣ | 0..1 | markdown | Use and/or publishing restrictions |
| kind | ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. |
 implementation | ΣC | 0..1 | BackboneElement | If this describes a specific instance |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 description | Σ | 1..1 | string | Describes this specific instance |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| TerminologyCapabilities.status | required | PublicationStatus |
| TerminologyCapabilities.jurisdiction | extensible | Jurisdiction ValueSet |
| TerminologyCapabilities.kind | required | CapabilityStatementKind |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | TerminologyCapabilities | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | TerminologyCapabilities | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | TerminologyCapabilities | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | TerminologyCapabilities | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | TerminologyCapabilities | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tcp-0 | warning | TerminologyCapabilities | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| tcp-2 | error | TerminologyCapabilities | A Capability Statement SHALL have at least one of description, software, or implementation element. : (description.count() + software.count() + implementation.count()) > 0 | |
| tcp-3 | error | TerminologyCapabilities | If kind = instance, implementation must be present and software may be present : (kind != 'instance') or implementation.exists() | |
| tcp-4 | error | TerminologyCapabilities | If kind = capability, implementation must be absent, software must be present : (kind != 'capability') or (implementation.exists().not() and software.exists()) | |
| tcp-5 | error | TerminologyCapabilities | If kind = requirements, implementation and software must be absent : (kind!='requirements') or (implementation.exists().not() and software.exists().not()) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TerminologyCapabilities | C | 1..1 | CRMIShareableTerminologyCapabilities | A statement of system capabilities | ||||
| id | Σ | 0..1 | id | 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 Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) | ||||
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact | ||||
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact | ||||
| identifier | S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | ||||
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) | ||||
| version | SΣ | 1..1 | string | Business version of the terminology capabilities | ||||
| name | SΣC | 0..1 | string | Name for this terminology capabilities (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this terminology capabilities (human friendly) | ||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date | SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..1 | markdown | Natural language description of the terminology capabilities | ||||
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | S | 0..1 | markdown | Why this terminology capabilities is defined | ||||
| copyright | SΣ | 0..1 | markdown | Use and/or publishing restrictions | ||||
| kind | ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. | ||||
 software | ΣC | 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 | ΣC | 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 | C | 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(CodeSystem) | 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 | ΣC | 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 Binding: CodeSearchSupport (required): The degree to which the server supports the code search parameter on ValueSet, if it is supported. | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| TerminologyCapabilities.language | preferred | CommonLanguages
| ||||
| TerminologyCapabilities.status | required | PublicationStatus | ||||
| TerminologyCapabilities.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| TerminologyCapabilities.kind | required | CapabilityStatementKind | ||||
| TerminologyCapabilities.codeSearch | required | CodeSearchSupport |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tcp-1 | error | TerminologyCapabilities.codeSystem | If there is more than one version, a version code must be defined : version.count() > 1 implies version.all(code.exists()) |
This structure is derived from CRMIShareableTerminologyCapabilities
Summary
Mandatory: 1 element
Must-Support: 18 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from CRMIShareableTerminologyCapabilities
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TerminologyCapabilities | C | 1..1 | CRMIShareableTerminologyCapabilities | A statement of system capabilities |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) |
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) |
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment |
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact |
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact |
| identifier | S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier |
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage |
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel |
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate |
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate |
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod |
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact |
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author |
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor |
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer |
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser |
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| url | SΣ | 1..1 | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) |
| version | SΣ | 1..1 | string | Business version of the terminology capabilities |
| name | SΣC | 0..1 | string | Name for this terminology capabilities (computer friendly) |
| title | SΣ | 1..1 | string | Name for this terminology capabilities (human friendly) |
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage |
| date | SΣ | 1..1 | dateTime | Date last changed |
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher |
| description | S | 1..1 | markdown | Natural language description of the terminology capabilities |
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support |
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
| purpose | S | 0..1 | markdown | Why this terminology capabilities is defined |
| copyright | SΣ | 0..1 | markdown | Use and/or publishing restrictions |
| kind | ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. |
| implementation | ΣC | 0..1 | BackboneElement | If this describes a specific instance |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| description | Σ | 1..1 | string | Describes this specific instance |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| TerminologyCapabilities.status | required | PublicationStatus |
| TerminologyCapabilities.jurisdiction | extensible | Jurisdiction ValueSet |
| TerminologyCapabilities.kind | required | CapabilityStatementKind |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | TerminologyCapabilities | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | TerminologyCapabilities | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | TerminologyCapabilities | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | TerminologyCapabilities | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | TerminologyCapabilities | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tcp-0 | warning | TerminologyCapabilities | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') | |
| tcp-2 | error | TerminologyCapabilities | A Capability Statement SHALL have at least one of description, software, or implementation element. : (description.count() + software.count() + implementation.count()) > 0 | |
| tcp-3 | error | TerminologyCapabilities | If kind = instance, implementation must be present and software may be present : (kind != 'instance') or implementation.exists() | |
| tcp-4 | error | TerminologyCapabilities | If kind = capability, implementation must be absent, software must be present : (kind != 'capability') or (implementation.exists().not() and software.exists()) | |
| tcp-5 | error | TerminologyCapabilities | If kind = requirements, implementation and software must be absent : (kind!='requirements') or (implementation.exists().not() and software.exists().not()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| TerminologyCapabilities | C | 1..1 | CRMIShareableTerminologyCapabilities | A statement of system capabilities | ||||
| id | Σ | 0..1 | id | 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 Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| knowledgeCapability | S | 0..* | code | shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapabilityValues (required) | ||||
| knowledgeRepresentationLevel | S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevelValues (required) | ||||
| artifactComment | S | 0..* | (Complex) | Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment | ||||
| versionAlgorithm | S | 0..1 | string, Coding | How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible): The algorithm used to compare versions for the artifact | ||||
| versionPolicy | S | 0..1 | Coding | metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy Values (extensible): The versioning policy of the artifact | ||||
| identifier | S | 0..* | Identifier | Additional identifier for the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier | ||||
| usage | S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage | ||||
| copyrightLabel | S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel | ||||
| approvalDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate | ||||
| lastReviewDate | S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate | ||||
| effectivePeriod | S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod | ||||
| topic | S | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-topic Binding: DefinitionTopic (example): Topics associated with the artifact | ||||
| author | S | 0..* | ContactDetail | Who authored the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-author | ||||
| editor | S | 0..* | ContactDetail | Who edited the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-editor | ||||
| reviewer | S | 0..* | ContactDetail | Who reviewed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer | ||||
| endorser | S | 0..* | ContactDetail | Who endorsed the {{title}} URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser | ||||
| relatedArtifact | S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| url | SΣ | 1..1 | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) | ||||
| version | SΣ | 1..1 | string | Business version of the terminology capabilities | ||||
| name | SΣC | 0..1 | string | Name for this terminology capabilities (computer friendly) | ||||
| title | SΣ | 1..1 | string | Name for this terminology capabilities (human friendly) | ||||
| status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental | SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
| date | SΣ | 1..1 | dateTime | Date last changed | ||||
| publisher | SΣ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact | SΣ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description | S | 1..1 | markdown | Natural language description of the terminology capabilities | ||||
| useContext | SΣ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction | SΣ | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose | S | 0..1 | markdown | Why this terminology capabilities is defined | ||||
| copyright | SΣ | 0..1 | markdown | Use and/or publishing restrictions | ||||
| kind | ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. | ||||
| software | ΣC | 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 | ΣC | 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 | C | 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(CodeSystem) | 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 | ΣC | 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 Binding: CodeSearchSupport (required): The degree to which the server supports the code search parameter on ValueSet, if it is supported. | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| TerminologyCapabilities.language | preferred | CommonLanguages
| ||||
| TerminologyCapabilities.status | required | PublicationStatus | ||||
| TerminologyCapabilities.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| TerminologyCapabilities.kind | required | CapabilityStatementKind | ||||
| TerminologyCapabilities.codeSearch | required | CodeSearchSupport |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| tcp-1 | error | TerminologyCapabilities.codeSystem | If there is more than one version, a version code must be defined : version.count() > 1 implies version.all(code.exists()) |
This structure is derived from CRMIShareableTerminologyCapabilities
Summary
Mandatory: 1 element
Must-Support: 18 elements
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ Clinical Decision Support WG. Package hl7.fhir.uv.crmi#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-08-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
