R4 Draft for Comment
TerminologyThis page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Vocabulary Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Not linked to any defined compartments |
StructureDefinition for terminologycapabilities
{
"resourceType": "StructureDefinition",
"id": "TerminologyCapabilities",
"meta": {
"lastUpdated": "2017-12-20T15:52:34.818+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "vocab"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/TerminologyCapabilities",
"name": "TerminologyCapabilities",
"status": "draft",
"date": "2017-12-20T15:52:34+11:00",
"publisher": "Health Level Seven International (Vocabulary)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/Vocab/index.cfm"
}
]
}
],
"description": "A Terminology Capabilities documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"fhirVersion": "3.2.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "TerminologyCapabilities",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"_baseDefinition": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-codegen-super",
"valueString": "MetadataResource"
}
]
},
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "TerminologyCapabilities",
"path": "TerminologyCapabilities",
"short": "A statement of system capabilities",
"definition": "A Terminology Capabilities documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"min": 1,
"max": "1",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "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",
"expression": "contained.all(('#'+id in %resource.descendants().reference) or descendants().where(reference = '#').exists())",
"xpath": "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::reference[@value='#'])]))",
"source": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"id": "TerminologyCapabilities.id",
"path": "TerminologyCapabilities.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.meta",
"path": "TerminologyCapabilities.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.implicitRules",
"path": "TerminologyCapabilities.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "TerminologyCapabilities.language",
"path": "TerminologyCapabilities.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "TerminologyCapabilities.text",
"path": "TerminologyCapabilities.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "TerminologyCapabilities.contained",
"path": "TerminologyCapabilities.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.extension",
"path": "TerminologyCapabilities.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.modifierExtension",
"path": "TerminologyCapabilities.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.url",
"path": "TerminologyCapabilities.url",
"short": "Logical URI to reference this terminology capabilities (globally unique)",
"definition": "An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this terminology capabilities is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the terminology capabilities. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the terminology capabilities to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "TerminologyCapabilities.version",
"path": "TerminologyCapabilities.version",
"short": "Business version of the terminology capabilities",
"definition": "The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different terminology capabilities instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the terminology capabilities with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.version"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "TerminologyCapabilities.name",
"path": "TerminologyCapabilities.name",
"short": "Name for this terminology capabilities (computer friendly)",
"definition": "A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.title",
"path": "TerminologyCapabilities.title",
"short": "Name for this terminology capabilities (human friendly)",
"definition": "A short, descriptive, user-friendly title for the terminology capabilities.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.status",
"path": "TerminologyCapabilities.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this terminology capabilities. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of terminology capabilitiess that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired terminology capabilities without due consideration. This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "TerminologyCapabilities.experimental",
"path": "TerminologyCapabilities.experimental",
"short": "For testing purposes, not real usage",
"definition": "A boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment": "Allows filtering of terminology capabilities that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental terminology capabilities in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level terminology capabilities.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "TerminologyCapabilities.date",
"path": "TerminologyCapabilities.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the terminology capabilities was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the terminology capabilities. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "TerminologyCapabilities.publisher",
"path": "TerminologyCapabilities.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the terminology capabilities.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the terminology capabilities is the organization or individual primarily responsible for the maintenance and upkeep of the terminology capabilities. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the terminology capabilities. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the terminology capabilities. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "TerminologyCapabilities.contact",
"path": "TerminologyCapabilities.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.description",
"path": "TerminologyCapabilities.description",
"short": "Natural language description of the terminology capabilities",
"definition": "A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment": "This description can be used to capture details such as why the terminology capabilities was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the terminology capabilities as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "TerminologyCapabilities.useContext",
"path": "TerminologyCapabilities.useContext",
"short": "Context the content is intended to support",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate terminology capabilities instances.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.jurisdiction",
"path": "TerminologyCapabilities.jurisdiction",
"short": "Intended jurisdiction for terminology capabilities (if applicable)",
"definition": "A legal or geographic region in which the terminology capabilities is intended to be used.",
"comment": "It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "TerminologyCapabilities.purpose",
"path": "TerminologyCapabilities.purpose",
"short": "Why this terminology capabilities is defined",
"definition": "Explaination of why this terminology capabilities is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the terminology capabilities Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this terminology capabilities.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "TerminologyCapabilities.copyright",
"path": "TerminologyCapabilities.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "TerminologyCapabilities.lockedDate",
"path": "TerminologyCapabilities.lockedDate",
"short": "Whether lockedDate is supported",
"definition": "Whether the server supports lockedDate.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.codeSystem",
"path": "TerminologyCapabilities.codeSystem",
"short": "A code system supported by the server",
"definition": "Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.",
"comment": "The code system - identified by it's system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.",
"alias": [
"1"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "tcp-1",
"severity": "error",
"human": "If there is more than one version, a version code must be defined",
"expression": "version.count() > 1 implies version.all(code.exists())",
"xpath": "(count(f:version) <= 1) or not exists(f:version[not(f:code)])"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.id",
"path": "TerminologyCapabilities.codeSystem.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.extension",
"path": "TerminologyCapabilities.codeSystem.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.modifierExtension",
"path": "TerminologyCapabilities.codeSystem.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.uri",
"path": "TerminologyCapabilities.codeSystem.uri",
"short": "URI for the Code System",
"definition": "URI for the Code System.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version",
"path": "TerminologyCapabilities.codeSystem.version",
"short": "Version of Code System supported",
"definition": "For the code system, a list of versions that are supported by the server.",
"comment": "Language translations might not be available for all codes.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.id",
"path": "TerminologyCapabilities.codeSystem.version.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.extension",
"path": "TerminologyCapabilities.codeSystem.version.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.modifierExtension",
"path": "TerminologyCapabilities.codeSystem.version.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.code",
"path": "TerminologyCapabilities.codeSystem.version.code",
"short": "Version identifier for this version",
"definition": "For version-less code systems, there should be a single version with no identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"tcp-1"
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.codeSystem.version.isDefault",
"path": "TerminologyCapabilities.codeSystem.version.isDefault",
"short": "If this is the default version for this code system",
"definition": "If this is the default version for this code system.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.codeSystem.version.compositional",
"path": "TerminologyCapabilities.codeSystem.version.compositional",
"short": "If compositional grammar is supported",
"definition": "If the compositional grammar defined by the code system is supported.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.language",
"path": "TerminologyCapabilities.codeSystem.version.language",
"short": "Language Displays supported",
"definition": "Language Displays supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter",
"path": "TerminologyCapabilities.codeSystem.version.filter",
"short": "Filter Properties supported",
"definition": "Filter Properties supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter.id",
"path": "TerminologyCapabilities.codeSystem.version.filter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter.extension",
"path": "TerminologyCapabilities.codeSystem.version.filter.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter.modifierExtension",
"path": "TerminologyCapabilities.codeSystem.version.filter.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter.code",
"path": "TerminologyCapabilities.codeSystem.version.filter.code",
"short": "Code of the property supported",
"definition": "Code of the property supported.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter.op",
"path": "TerminologyCapabilities.codeSystem.version.filter.op",
"short": "Operations supported for the property",
"definition": "Operations supported for the property.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.property",
"path": "TerminologyCapabilities.codeSystem.version.property",
"short": "Properties supported for $lookup",
"definition": "Properties supported for $lookup.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.expansion",
"path": "TerminologyCapabilities.expansion",
"short": "Information about the $expansion operation",
"definition": "Information about the $expansion operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "TerminologyCapabilities.expansion.id",
"path": "TerminologyCapabilities.expansion.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.expansion.extension",
"path": "TerminologyCapabilities.expansion.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.expansion.modifierExtension",
"path": "TerminologyCapabilities.expansion.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.expansion.hierarchical",
"path": "TerminologyCapabilities.expansion.hierarchical",
"short": "Whether the server can return nested value sets",
"definition": "Whether the server can return nested value sets.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.expansion.paging",
"path": "TerminologyCapabilities.expansion.paging",
"short": "Whether the server supports paging on expansion",
"definition": "Whether the server supports paging on expansion.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.expansion.incomplete",
"path": "TerminologyCapabilities.expansion.incomplete",
"short": "Allow request for incomplete expansions?",
"definition": "Allow request for incomplete expansions?",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.expansion.definition",
"path": "TerminologyCapabilities.expansion.definition",
"short": "Supported fields on ExpansionProfile",
"definition": "Supported fields on ExpansionProfile.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"id": "TerminologyCapabilities.expansion.profile",
"path": "TerminologyCapabilities.expansion.profile",
"short": "Supported expansion profiles",
"definition": "Supported expansion profiles.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ExpansionProfile"
}
]
},
{
"id": "TerminologyCapabilities.expansion.textFilter",
"path": "TerminologyCapabilities.expansion.textFilter",
"short": "Documentation about text searching works",
"definition": "Documentation about text searching works.",
"comment": "This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "TerminologyCapabilities.codeSearch",
"path": "TerminologyCapabilities.codeSearch",
"short": "explicit | all",
"definition": "The degree to which the the server supports the code search parameter on ValueSet, if it is supported.",
"comment": "See notes on the [ValueSet](valueset.html) resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CodeSearchSupport"
}
],
"strength": "required",
"description": "The degree to which the the server supports the code search parameter on ValueSet, if it is supported",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/code-search-support"
}
}
},
{
"id": "TerminologyCapabilities.validateCode",
"path": "TerminologyCapabilities.validateCode",
"short": "Information about the $validation operation",
"definition": "Information about the $validation operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "TerminologyCapabilities.validateCode.id",
"path": "TerminologyCapabilities.validateCode.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.validateCode.extension",
"path": "TerminologyCapabilities.validateCode.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.validateCode.modifierExtension",
"path": "TerminologyCapabilities.validateCode.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.validateCode.translations",
"path": "TerminologyCapabilities.validateCode.translations",
"short": "Whether translations are validated",
"definition": "Whether translations are validated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.translation",
"path": "TerminologyCapabilities.translation",
"short": "Information about the $translation operation",
"definition": "Information about the $translation operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "TerminologyCapabilities.translation.id",
"path": "TerminologyCapabilities.translation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.translation.extension",
"path": "TerminologyCapabilities.translation.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.translation.modifierExtension",
"path": "TerminologyCapabilities.translation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.translation.needsMap",
"path": "TerminologyCapabilities.translation.needsMap",
"short": "Whether the client must identify the map",
"definition": "Whether the client must identify the map.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.closure",
"path": "TerminologyCapabilities.closure",
"short": "Information about the $closure operation",
"definition": "Whether the $closure operation is supported.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "TerminologyCapabilities.closure.id",
"path": "TerminologyCapabilities.closure.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.closure.extension",
"path": "TerminologyCapabilities.closure.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "TerminologyCapabilities.closure.modifierExtension",
"path": "TerminologyCapabilities.closure.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "TerminologyCapabilities.closure.translation",
"path": "TerminologyCapabilities.closure.translation",
"short": "If cross-system closure is supported",
"definition": "If cross-system closure is supported.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
}
]
},
"differential": {
"element": [
{
"id": "TerminologyCapabilities",
"path": "TerminologyCapabilities",
"short": "A statement of system capabilities",
"definition": "A Terminology Capabilities documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.",
"min": 1,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "conformance.behavior"
}
]
},
{
"id": "TerminologyCapabilities.url",
"path": "TerminologyCapabilities.url",
"short": "Logical URI to reference this terminology capabilities (globally unique)",
"definition": "An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this terminology capabilities is (or will be) published.",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe URL SHOULD include the major version of the terminology capabilities. For more information see [Technical and Business Versions](resource.html#versions).",
"requirements": "Allows the terminology capabilities to be referenced by a single globally unique identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "TerminologyCapabilities.version",
"path": "TerminologyCapabilities.version",
"short": "Business version of the terminology capabilities",
"definition": "The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
"comment": "There may be different terminology capabilities instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the terminology capabilities with the format [url]|[version].",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.version"
},
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "TerminologyCapabilities.name",
"path": "TerminologyCapabilities.name",
"short": "Name for this terminology capabilities (computer friendly)",
"definition": "A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.",
"requirements": "Support human navigation and code generation.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.title",
"path": "TerminologyCapabilities.title",
"short": "Name for this terminology capabilities (human friendly)",
"definition": "A short, descriptive, user-friendly title for the terminology capabilities.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.status",
"path": "TerminologyCapabilities.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this terminology capabilities. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of terminology capabilitiess that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired terminology capabilities without due consideration. This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "TerminologyCapabilities.experimental",
"path": "TerminologyCapabilities.experimental",
"short": "For testing purposes, not real usage",
"definition": "A boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comment": "Allows filtering of terminology capabilities that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental terminology capabilities in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level terminology capabilities.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "TerminologyCapabilities.date",
"path": "TerminologyCapabilities.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the terminology capabilities was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.",
"comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the terminology capabilities. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.recorded"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "TerminologyCapabilities.publisher",
"path": "TerminologyCapabilities.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the terminology capabilities.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the terminology capabilities is the organization or individual primarily responsible for the maintenance and upkeep of the terminology capabilities. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the terminology capabilities. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the terminology capabilities. May also allow for contact.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.witness"
},
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "TerminologyCapabilities.contact",
"path": "TerminologyCapabilities.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.description",
"path": "TerminologyCapabilities.description",
"short": "Natural language description of the terminology capabilities",
"definition": "A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.",
"comment": "This description can be used to capture details such as why the terminology capabilities was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the terminology capabilities as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). This does not need to be populated if the description is adequately implied by the software or implementation details.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "TerminologyCapabilities.useContext",
"path": "TerminologyCapabilities.useContext",
"short": "Context the content is intended to support",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate terminology capabilities instances.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.jurisdiction",
"path": "TerminologyCapabilities.jurisdiction",
"short": "Intended jurisdiction for terminology capabilities (if applicable)",
"definition": "A legal or geographic region in which the terminology capabilities is intended to be used.",
"comment": "It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "TerminologyCapabilities.purpose",
"path": "TerminologyCapabilities.purpose",
"short": "Why this terminology capabilities is defined",
"definition": "Explaination of why this terminology capabilities is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the terminology capabilities Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this terminology capabilities.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "TerminologyCapabilities.copyright",
"path": "TerminologyCapabilities.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"isSummary": true,
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "TerminologyCapabilities.lockedDate",
"path": "TerminologyCapabilities.lockedDate",
"short": "Whether lockedDate is supported",
"definition": "Whether the server supports lockedDate.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.codeSystem",
"path": "TerminologyCapabilities.codeSystem",
"short": "A code system supported by the server",
"definition": "Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.",
"comment": "The code system - identified by it's system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.",
"alias": [
"1"
],
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "tcp-1",
"severity": "error",
"human": "If there is more than one version, a version code must be defined",
"expression": "version.count() > 1 implies version.all(code.exists())",
"xpath": "(count(f:version) <= 1) or not exists(f:version[not(f:code)])"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.uri",
"path": "TerminologyCapabilities.codeSystem.uri",
"short": "URI for the Code System",
"definition": "URI for the Code System.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version",
"path": "TerminologyCapabilities.codeSystem.version",
"short": "Version of Code System supported",
"definition": "For the code system, a list of versions that are supported by the server.",
"comment": "Language translations might not be available for all codes.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.code",
"path": "TerminologyCapabilities.codeSystem.version.code",
"short": "Version identifier for this version",
"definition": "For version-less code systems, there should be a single version with no identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"tcp-1"
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.codeSystem.version.isDefault",
"path": "TerminologyCapabilities.codeSystem.version.isDefault",
"short": "If this is the default version for this code system",
"definition": "If this is the default version for this code system.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "TerminologyCapabilities.codeSystem.version.compositional",
"path": "TerminologyCapabilities.codeSystem.version.compositional",
"short": "If compositional grammar is supported",
"definition": "If the compositional grammar defined by the code system is supported.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.language",
"path": "TerminologyCapabilities.codeSystem.version.language",
"short": "Language Displays supported",
"definition": "Language Displays supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter",
"path": "TerminologyCapabilities.codeSystem.version.filter",
"short": "Filter Properties supported",
"definition": "Filter Properties supported.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter.code",
"path": "TerminologyCapabilities.codeSystem.version.filter.code",
"short": "Code of the property supported",
"definition": "Code of the property supported.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.filter.op",
"path": "TerminologyCapabilities.codeSystem.version.filter.op",
"short": "Operations supported for the property",
"definition": "Operations supported for the property.",
"min": 1,
"max": "*",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.codeSystem.version.property",
"path": "TerminologyCapabilities.codeSystem.version.property",
"short": "Properties supported for $lookup",
"definition": "Properties supported for $lookup.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
]
},
{
"id": "TerminologyCapabilities.expansion",
"path": "TerminologyCapabilities.expansion",
"short": "Information about the $expansion operation",
"definition": "Information about the $expansion operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "TerminologyCapabilities.expansion.hierarchical",
"path": "TerminologyCapabilities.expansion.hierarchical",
"short": "Whether the server can return nested value sets",
"definition": "Whether the server can return nested value sets.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.expansion.paging",
"path": "TerminologyCapabilities.expansion.paging",
"short": "Whether the server supports paging on expansion",
"definition": "Whether the server supports paging on expansion.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.expansion.incomplete",
"path": "TerminologyCapabilities.expansion.incomplete",
"short": "Allow request for incomplete expansions?",
"definition": "Allow request for incomplete expansions?",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.expansion.definition",
"path": "TerminologyCapabilities.expansion.definition",
"short": "Supported fields on ExpansionProfile",
"definition": "Supported fields on ExpansionProfile.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/StructureDefinition"
}
]
},
{
"id": "TerminologyCapabilities.expansion.profile",
"path": "TerminologyCapabilities.expansion.profile",
"short": "Supported expansion profiles",
"definition": "Supported expansion profiles.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ExpansionProfile"
}
]
},
{
"id": "TerminologyCapabilities.expansion.textFilter",
"path": "TerminologyCapabilities.expansion.textFilter",
"short": "Documentation about text searching works",
"definition": "Documentation about text searching works.",
"comment": "This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.",
"min": 0,
"max": "1",
"type": [
{
"code": "markdown"
}
]
},
{
"id": "TerminologyCapabilities.codeSearch",
"path": "TerminologyCapabilities.codeSearch",
"short": "explicit | all",
"definition": "The degree to which the the server supports the code search parameter on ValueSet, if it is supported.",
"comment": "See notes on the [ValueSet](valueset.html) resource.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CodeSearchSupport"
}
],
"strength": "required",
"description": "The degree to which the the server supports the code search parameter on ValueSet, if it is supported",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/code-search-support"
}
}
},
{
"id": "TerminologyCapabilities.validateCode",
"path": "TerminologyCapabilities.validateCode",
"short": "Information about the $validation operation",
"definition": "Information about the $validation operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "TerminologyCapabilities.validateCode.translations",
"path": "TerminologyCapabilities.validateCode.translations",
"short": "Whether translations are validated",
"definition": "Whether translations are validated.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.translation",
"path": "TerminologyCapabilities.translation",
"short": "Information about the $translation operation",
"definition": "Information about the $translation operation.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "TerminologyCapabilities.translation.needsMap",
"path": "TerminologyCapabilities.translation.needsMap",
"short": "Whether the client must identify the map",
"definition": "Whether the client must identify the map.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "TerminologyCapabilities.closure",
"path": "TerminologyCapabilities.closure",
"short": "Information about the $closure operation",
"definition": "Whether the $closure operation is supported.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "TerminologyCapabilities.closure.translation",
"path": "TerminologyCapabilities.closure.translation",
"short": "If cross-system closure is supported",
"definition": "If cross-system closure is supported.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 4 Draft for Comment (Jan-2018 v3.2.0-12885) generated on Wed, Dec 20, 2017 15:58+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
|
Propose a change