Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild
Canonical Resource Management Infrastructure Implementation Guide
1.1.0-cibuild - cibuild
Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 1.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishableterminologycapabilities | Version: 1.1.0-cibuild | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: CRMIPublishableTerminologyCapabilities | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.44 | ||||
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.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  TerminologyCapabilities |
C | 1..1 | TerminologyCapabilities | A statement of system capabilities dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management tcp-0: Name should be usable as an identifier for the module by machine processing applications such as code generation tcp-2: A Capability Statement SHALL have at least one of description, software, or implementation element. tcp-3: If kind = instance, implementation must be present and software may be present tcp-4: If kind = capability, implementation must be absent, software must be present tcp-5: If kind = requirements, implementation and software must be absent |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
  Slices for extension |
Content/Rules for all slices | |||
   identifier |
S | 0..* | Identifier | Additional identifier for the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-identifier ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| usage |
S | 0..1 | markdown | Describes the clinical usage of the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-usage ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| copyrightLabel |
S | 0..1 | string | Copyright holder and year(s) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| approvalDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| lastReviewDate |
S | 0..1 | date | When the artifact was approved by publisher URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| effectivePeriod |
S | 0..1 | Period | When the artifact is expected to be used URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| 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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| author |
S | 0..* | ContactDetail | Who authored the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-author ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| editor |
S | 0..* | ContactDetail | Who edited the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-editor ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| reviewer |
S | 0..* | ContactDetail | Who reviewed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| endorser |
S | 0..* | ContactDetail | Who endorsed the artifact URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 relatedArtifact |
S | 0..* | RelatedArtifact | Additional documentation, citations, etc. URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. ele-1: All FHIR elements must have a @value or children |
| date |
SΣ | 1..1 | dateTime | Date last changed ele-1: All FHIR elements must have a @value or children |
 contact |
SΣ | 0..* | ContactDetail | Contact details for the publisher ele-1: All FHIR elements must have a @value or children |
| useContext |
SΣ | 0..* | UsageContext | The context that the content is intended to support ele-1: All FHIR elements must have a @value or children |
| 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. ele-1: All FHIR elements must have a @value or children |
| purpose |
S | 0..1 | markdown | Why this terminology capabilities is defined ele-1: All FHIR elements must have a @value or children |
| copyright |
SΣ | 0..1 | markdown | Use and/or publishing restrictions ele-1: All FHIR elements must have a @value or children |
| kind |
ΣC | 1..1 | code | instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used. ele-1: All FHIR elements must have a @value or children |
 implementation |
ΣC | 0..1 | BackboneElement | If this describes a specific instance ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 description |
Σ | 1..1 | string | Describes this specific instance ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| TerminologyCapabilities.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| TerminologyCapabilities.jurisdiction | extensible | Jurisdiction ValueSethttp://hl7.org/fhir/ValueSet/jurisdictionfrom the FHIR Standard | |
| TerminologyCapabilities.kind | required | CapabilityStatementKindhttp://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1from 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()) |
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#1.1.0-cibuild based on FHIR 4.0.1. Generated 2025-02-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
