Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot2 - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot2: STU1 Ballot 2) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: CRMI Publishable TerminologyCapabilities

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableterminologycapabilities Version: 1.0.0-ballot2
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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from TerminologyCapabilities

NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities 1..1TerminologyCapabilitiesA statement of system capabilities
... identifier S0..*IdentifierAdditional identifier for the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
... usage S0..1markdownDescribes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... lastReviewDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S0..1PeriodWhen the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S0..*ContactDetailWho edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S0..*ContactDetailWho reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S0..*ContactDetailWho endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
... purpose S0..1markdownWhy this terminology capabilities is defined
... copyright S0..1markdownUse and/or publishing restrictions

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities C1..1TerminologyCapabilitiesA statement of system capabilities
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier S0..*IdentifierAdditional identifier for the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
... usage S0..1markdownDescribes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
... approvalDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S0..1PeriodWhen the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S0..*ContactDetailWho edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S0..*ContactDetailWho reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S0..*ContactDetailWho endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ1..1dateTimeDate last changed
... contact SΣ0..*ContactDetailContact details for the publisher
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this terminology capabilities is defined
... copyright SΣ0..1markdownUse and/or publishing restrictions
... kind ΣC1..1codeinstance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.

... implementation ΣC0..1BackboneElementIf this describes a specific instance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ1..1stringDescribes this specific instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
TerminologyCapabilities.statusrequiredPublicationStatus
TerminologyCapabilities.jurisdictionextensibleJurisdiction ValueSet
TerminologyCapabilities.kindrequiredCapabilityStatementKind

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTerminologyCapabilitiesIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTerminologyCapabilitiesIf 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-4errorTerminologyCapabilitiesIf 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-5errorTerminologyCapabilitiesIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTerminologyCapabilitiesA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tcp-0warningTerminologyCapabilitiesName 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-2errorTerminologyCapabilitiesA Capability Statement SHALL have at least one of description, software, or implementation element.
: (description.count() + software.count() + implementation.count()) > 0
tcp-3errorTerminologyCapabilitiesIf kind = instance, implementation must be present and software may be present
: (kind != 'instance') or implementation.exists()
tcp-4errorTerminologyCapabilitiesIf kind = capability, implementation must be absent, software must be present
: (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5errorTerminologyCapabilitiesIf kind = requirements, implementation and software must be absent
: (kind!='requirements') or (implementation.exists().not() and software.exists().not())
NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities C1..1TerminologyCapabilitiesA statement of system capabilities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier S0..*IdentifierAdditional identifier for the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
... usage S0..1markdownDescribes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S0..1PeriodWhen the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S0..*ContactDetailWho edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S0..*ContactDetailWho reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S0..*ContactDetailWho endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this terminology capabilities, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the terminology capabilities
... name ΣC0..1stringName for this terminology capabilities (computer friendly)
... title Σ0..1stringName for this terminology capabilities (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the terminology capabilities
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this terminology capabilities is defined
... copyright SΣ0..1markdownUse and/or publishing restrictions
... kind ΣC1..1codeinstance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.

... software ΣC0..1BackboneElementSoftware that is covered by this terminology capability statement
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
... implementation ΣC0..1BackboneElementIf this describes a specific instance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1urlBase URL for the implementation
... lockedDate Σ0..1booleanWhether lockedDate is supported
... codeSystem C0..*BackboneElementA code system supported by the server
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri 0..1canonical(CodeSystem)URI for the Code System
.... version 0..*BackboneElementVersion of Code System supported
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code ΣC0..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
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... 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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1codeExpansion Parameter name
..... documentation 0..1stringDescription of support for parameter
.... textFilter 0..1markdownDocumentation about text searching works
... codeSearch 0..1codeexplicit | all
Binding: CodeSearchSupport (required): The degree to which the server supports the code search parameter on ValueSet, if it is supported.

... validateCode 0..1BackboneElementInformation about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... translations 1..1booleanWhether translations are validated
... translation 0..1BackboneElementInformation about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... needsMap 1..1booleanWhether the client must identify the map
... closure 0..1BackboneElementInformation about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... translation 0..1booleanIf cross-system closure is supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
TerminologyCapabilities.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
TerminologyCapabilities.statusrequiredPublicationStatus
TerminologyCapabilities.jurisdictionextensibleJurisdiction ValueSet
TerminologyCapabilities.kindrequiredCapabilityStatementKind
TerminologyCapabilities.codeSearchrequiredCodeSearchSupport

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTerminologyCapabilitiesIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTerminologyCapabilitiesIf 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-4errorTerminologyCapabilitiesIf 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-5errorTerminologyCapabilitiesIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTerminologyCapabilitiesA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tcp-0warningTerminologyCapabilitiesName 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-1errorTerminologyCapabilities.codeSystemIf there is more than one version, a version code must be defined
: version.count() > 1 implies version.all(code.exists())
tcp-2errorTerminologyCapabilitiesA Capability Statement SHALL have at least one of description, software, or implementation element.
: (description.count() + software.count() + implementation.count()) > 0
tcp-3errorTerminologyCapabilitiesIf kind = instance, implementation must be present and software may be present
: (kind != 'instance') or implementation.exists()
tcp-4errorTerminologyCapabilitiesIf kind = capability, implementation must be absent, software must be present
: (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5errorTerminologyCapabilitiesIf kind = requirements, implementation and software must be absent
: (kind!='requirements') or (implementation.exists().not() and software.exists().not())

Differential View

This structure is derived from TerminologyCapabilities

NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities 1..1TerminologyCapabilitiesA statement of system capabilities
... identifier S0..*IdentifierAdditional identifier for the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
... usage S0..1markdownDescribes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... lastReviewDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S0..1PeriodWhen the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S0..*ContactDetailWho edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S0..*ContactDetailWho reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S0..*ContactDetailWho endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... date S1..1dateTimeDate last changed
... contact S0..*ContactDetailContact details for the publisher
... useContext S0..*UsageContextThe context that the content is intended to support
... jurisdiction S0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
... purpose S0..1markdownWhy this terminology capabilities is defined
... copyright S0..1markdownUse and/or publishing restrictions

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities C1..1TerminologyCapabilitiesA statement of system capabilities
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier S0..*IdentifierAdditional identifier for the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
... usage S0..1markdownDescribes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
... approvalDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S0..1PeriodWhen the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S0..*ContactDetailWho edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S0..*ContactDetailWho reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S0..*ContactDetailWho endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ1..1dateTimeDate last changed
... contact SΣ0..*ContactDetailContact details for the publisher
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this terminology capabilities is defined
... copyright SΣ0..1markdownUse and/or publishing restrictions
... kind ΣC1..1codeinstance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.

... implementation ΣC0..1BackboneElementIf this describes a specific instance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ1..1stringDescribes this specific instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
TerminologyCapabilities.statusrequiredPublicationStatus
TerminologyCapabilities.jurisdictionextensibleJurisdiction ValueSet
TerminologyCapabilities.kindrequiredCapabilityStatementKind

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTerminologyCapabilitiesIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTerminologyCapabilitiesIf 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-4errorTerminologyCapabilitiesIf 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-5errorTerminologyCapabilitiesIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTerminologyCapabilitiesA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tcp-0warningTerminologyCapabilitiesName 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-2errorTerminologyCapabilitiesA Capability Statement SHALL have at least one of description, software, or implementation element.
: (description.count() + software.count() + implementation.count()) > 0
tcp-3errorTerminologyCapabilitiesIf kind = instance, implementation must be present and software may be present
: (kind != 'instance') or implementation.exists()
tcp-4errorTerminologyCapabilitiesIf kind = capability, implementation must be absent, software must be present
: (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5errorTerminologyCapabilitiesIf kind = requirements, implementation and software must be absent
: (kind!='requirements') or (implementation.exists().not() and software.exists().not())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. TerminologyCapabilities C1..1TerminologyCapabilitiesA statement of system capabilities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier S0..*IdentifierAdditional identifier for the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier
... usage S0..1markdownDescribes the clinical usage of the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-usage
... copyrightLabel S0..1stringCopyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... approvalDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate
... lastReviewDate S0..1dateWhen the artifact was approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate
... effectivePeriod S0..1PeriodWhen the artifact is expected to be used
URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod
... topic S0..*CodeableConceptE.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact


... author S0..*ContactDetailWho authored the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
... editor S0..*ContactDetailWho edited the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
... reviewer S0..*ContactDetailWho reviewed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
... endorser S0..*ContactDetailWho endorsed the {{title}}
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
... relatedArtifact S0..*RelatedArtifactAdditional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriCanonical identifier for this terminology capabilities, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the terminology capabilities
... name ΣC0..1stringName for this terminology capabilities (computer friendly)
... title Σ0..1stringName for this terminology capabilities (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact SΣ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the terminology capabilities
... useContext SΣ0..*UsageContextThe context that the content is intended to support
... jurisdiction SΣ0..*CodeableConceptIntended jurisdiction for terminology capabilities (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose S0..1markdownWhy this terminology capabilities is defined
... copyright SΣ0..1markdownUse and/or publishing restrictions
... kind ΣC1..1codeinstance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.

... software ΣC0..1BackboneElementSoftware that is covered by this terminology capability statement
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
... implementation ΣC0..1BackboneElementIf this describes a specific instance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1urlBase URL for the implementation
... lockedDate Σ0..1booleanWhether lockedDate is supported
... codeSystem C0..*BackboneElementA code system supported by the server
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri 0..1canonical(CodeSystem)URI for the Code System
.... version 0..*BackboneElementVersion of Code System supported
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code ΣC0..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
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... 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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... 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
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name 1..1codeExpansion Parameter name
..... documentation 0..1stringDescription of support for parameter
.... textFilter 0..1markdownDocumentation about text searching works
... codeSearch 0..1codeexplicit | all
Binding: CodeSearchSupport (required): The degree to which the server supports the code search parameter on ValueSet, if it is supported.

... validateCode 0..1BackboneElementInformation about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... translations 1..1booleanWhether translations are validated
... translation 0..1BackboneElementInformation about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... needsMap 1..1booleanWhether the client must identify the map
... closure 0..1BackboneElementInformation about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... translation 0..1booleanIf cross-system closure is supported

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
TerminologyCapabilities.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
TerminologyCapabilities.statusrequiredPublicationStatus
TerminologyCapabilities.jurisdictionextensibleJurisdiction ValueSet
TerminologyCapabilities.kindrequiredCapabilityStatementKind
TerminologyCapabilities.codeSearchrequiredCodeSearchSupport

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorTerminologyCapabilitiesIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorTerminologyCapabilitiesIf 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-4errorTerminologyCapabilitiesIf 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-5errorTerminologyCapabilitiesIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceTerminologyCapabilitiesA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
tcp-0warningTerminologyCapabilitiesName 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-1errorTerminologyCapabilities.codeSystemIf there is more than one version, a version code must be defined
: version.count() > 1 implies version.all(code.exists())
tcp-2errorTerminologyCapabilitiesA Capability Statement SHALL have at least one of description, software, or implementation element.
: (description.count() + software.count() + implementation.count()) > 0
tcp-3errorTerminologyCapabilitiesIf kind = instance, implementation must be present and software may be present
: (kind != 'instance') or implementation.exists()
tcp-4errorTerminologyCapabilitiesIf kind = capability, implementation must be absent, software must be present
: (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5errorTerminologyCapabilitiesIf kind = requirements, implementation and software must be absent
: (kind!='requirements') or (implementation.exists().not() and software.exists().not())

 

Other representations of profile: CSV, Excel, Schematron