Terminology Change Set Exchange, published by HL7 International / Terminology Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/termchangeset-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/changeset-terminologycapabilities-profile | Version: 1.0.0 | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: ChangeSetTerminologyCapabilities |
Profile of CodeSystem to enable lossless representation of a Terminology Change Set aligned with Tinkar information model requirements
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | TerminologyCapabilities | A statement of system capabilities Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Update Methods URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods Binding: Terminology Server Update Methods ValueSet (example) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date last changed |
![]() ![]() ![]() |
ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. |
![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | If this describes a specific instance |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Describes this specific instance |
![]() |
Path | Conformance | ValueSet | URI |
TerminologyCapabilities.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 From the FHIR Standard | |
TerminologyCapabilities.kind | required | CapabilityStatementKindhttp://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 From the FHIR Standard |
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()) |
This structure is derived from TerminologyCapabilities
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | TerminologyCapabilities | A statement of system capabilities | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Update Methods URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods Binding: Terminology Server Update Methods ValueSet (example) |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | TerminologyCapabilities | A statement of system capabilities Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Update Methods URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods Binding: Terminology Server Update Methods ValueSet (example) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the terminology capabilities | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this terminology capabilities (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this terminology capabilities (human friendly) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | markdown | Natural language description of the terminology capabilities | |||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this terminology capabilities is defined | |||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Use and/or publishing restrictions | ||||
![]() ![]() ![]() |
ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Software that is covered by this terminology capability statement | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | A name the software is known by | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version covered by this statement | ||||
![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | If this describes a specific instance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Describes this specific instance | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Base URL for the implementation | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether lockedDate is supported | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A code system supported by the server Constraints: tcp-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | canonical(CodeSystem) | URI for the Code System | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Version of Code System supported | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Version identifier for this version | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this is the default version for this code system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If compositional grammar is supported | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | code | Language Displays supported | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Filter Properties supported | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Code of the property supported | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | code | Operations supported for the property | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | code | Properties supported for $lookup | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether subsumption is supported | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ValueSet/$expand](valueset-operation-expand.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the server can return nested value sets | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the server supports paging on expansion | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Allow request for incomplete expansions? | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Supported expansion parameter | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Expansion Parameter name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Description of support for parameter | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Documentation about text searching works | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether translations are validated | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether the client must identify the map | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If cross-system closure is supported | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
TerminologyCapabilities.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
TerminologyCapabilities.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 From the FHIR Standard | ||||
TerminologyCapabilities.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction From the FHIR Standard | ||||
TerminologyCapabilities.kind | required | CapabilityStatementKindhttp://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 From the FHIR Standard | ||||
TerminologyCapabilities.codeSearch | required | CodeSearchSupporthttp://hl7.org/fhir/ValueSet/code-search-support|4.0.1 From the FHIR Standard |
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-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()) | |
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()) |
This structure is derived from TerminologyCapabilities
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | TerminologyCapabilities | A statement of system capabilities Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Update Methods URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods Binding: Terminology Server Update Methods ValueSet (example) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date last changed |
![]() ![]() ![]() |
ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. |
![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | If this describes a specific instance |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Describes this specific instance |
![]() |
Path | Conformance | ValueSet | URI |
TerminologyCapabilities.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 From the FHIR Standard | |
TerminologyCapabilities.kind | required | CapabilityStatementKindhttp://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 From the FHIR Standard |
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()) |
Differential View
This structure is derived from TerminologyCapabilities
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | TerminologyCapabilities | A statement of system capabilities | |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Update Methods URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods Binding: Terminology Server Update Methods ValueSet (example) |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | TerminologyCapabilities | A statement of system capabilities Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Update Methods URL: http://hl7.org/fhir/uv/termchangeset/StructureDefinition/update-methods Binding: Terminology Server Update Methods ValueSet (example) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Business version of the terminology capabilities | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Name for this terminology capabilities (computer friendly) | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name for this terminology capabilities (human friendly) | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
0..1 | markdown | Natural language description of the terminology capabilities | |||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this terminology capabilities is defined | |||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Use and/or publishing restrictions | ||||
![]() ![]() ![]() |
ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Software that is covered by this terminology capability statement | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | A name the software is known by | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version covered by this statement | ||||
![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | If this describes a specific instance | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Describes this specific instance | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Base URL for the implementation | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether lockedDate is supported | ||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | A code system supported by the server Constraints: tcp-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | canonical(CodeSystem) | URI for the Code System | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Version of Code System supported | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Version identifier for this version | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this is the default version for this code system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If compositional grammar is supported | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | code | Language Displays supported | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Filter Properties supported | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Code of the property supported | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | code | Operations supported for the property | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | code | Properties supported for $lookup | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether subsumption is supported | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ValueSet/$expand](valueset-operation-expand.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the server can return nested value sets | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Whether the server supports paging on expansion | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Allow request for incomplete expansions? | |||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Supported expansion parameter | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Expansion Parameter name | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Description of support for parameter | |||||
![]() ![]() ![]() ![]() |
0..1 | markdown | Documentation about text searching works | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether translations are validated | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | boolean | Whether the client must identify the map | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If cross-system closure is supported | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
TerminologyCapabilities.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
TerminologyCapabilities.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 From the FHIR Standard | ||||
TerminologyCapabilities.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdiction From the FHIR Standard | ||||
TerminologyCapabilities.kind | required | CapabilityStatementKindhttp://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 From the FHIR Standard | ||||
TerminologyCapabilities.codeSearch | required | CodeSearchSupporthttp://hl7.org/fhir/ValueSet/code-search-support|4.0.1 From the FHIR Standard |
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-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()) | |
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()) |
This structure is derived from TerminologyCapabilities
Other representations of profile: CSV, Excel, Schematron