R4 Ballot #2 (Mixed Normative/Trial use)
TerminologyThis page is part of the FHIR Specification (v3.5.0: R4 Ballot #2). 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 |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for terminologycapabilities
{
"resourceType" : "StructureDefinition",
"id" : "TerminologyCapabilities",
"meta" : {
"lastUpdated" : "2018-08-19T21:48:56.559+10:00"
},
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString" : "Foundation.Terminology"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueString" : "Trial Use"
},
{
"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" : "2018-08-19T21:48:56+10: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.5.0",
"mapping" : [{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "workflow",
"uri" : "http://hl7.org/fhir/workflow",
"name" : "Workflow Pattern"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/fivews",
"name" : "FiveWs Pattern"
},
{
"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",
"base" : {
"path" : "TerminologyCapabilities",
"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-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.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()",
"xpath" : "not(exists(for $contained in f:contained return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source" : "DomainResource"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean" : true
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a guman readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}],
"key" : "dom-6",
"severity" : "warning",
"human" : "A resource should have narrative for robust management",
"expression" : "text.div.exists()",
"xpath" : "exists(f:text/h:div)",
"source" : "DomainResource"
},
{
"key" : "dom-5",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression" : "contained.meta.security.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:security))",
"source" : "DomainResource"
},
{
"key" : "tcp-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "tcp-3",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "tcp-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "tcp-5",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
},
{
"key" : "tcp-4",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"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"
}],
"isModifier" : false,
"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"
}],
"isModifier" : false,
"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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : true,
"isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"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"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical" : "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" : "preferred",
"description" : "A human language.",
"valueSet" : "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 can 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 information is added later.",
"alias" : ["narrative",
"html",
"xhtml",
"display"],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "Narrative"
}],
"isModifier" : false,
"isSummary" : false,
"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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias" : ["inline resources",
"anonymous resources",
"contained resources"],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "Resource"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.url",
"path" : "TerminologyCapabilities.url",
"short" : "Canonical identifier for this terminology capabilities, represented as a URI (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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.",
"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 determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [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",
"base" : {
"path" : "TerminologyCapabilities.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "uri"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"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",
"base" : {
"path" : "TerminologyCapabilities.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.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 alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.name",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"isModifier" : false,
"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",
"base" : {
"path" : "TerminologyCapabilities.title",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"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 versus not.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",
"base" : {
"path" : "TerminologyCapabilities.status",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : true,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"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 an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.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 capabilitiess that are appropriate for use versus not.",
"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",
"base" : {
"path" : "TerminologyCapabilities.experimental",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "TerminologyCapabilities.date",
"path" : "TerminologyCapabilities.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the terminology capabilities was published. The date must change 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",
"base" : {
"path" : "TerminologyCapabilities.date",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "dateTime"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "TerminologyCapabilities.publisher",
"path" : "TerminologyCapabilities.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual 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",
"base" : {
"path" : "TerminologyCapabilities.publisher",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.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" : "*",
"base" : {
"path" : "TerminologyCapabilities.contact",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "ContactDetail"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"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 terminology capabilities is presumed to be the predominant language in the place the terminology capabilities 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",
"base" : {
"path" : "TerminologyCapabilities.description",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "TerminologyCapabilities.useContext",
"path" : "TerminologyCapabilities.useContext",
"short" : "The context that 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 that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.useContext",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "UsageContext"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"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" : "*",
"base" : {
"path" : "TerminologyCapabilities.jurisdiction",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "CodeableConcept"
}],
"isModifier" : false,
"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.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "TerminologyCapabilities.purpose",
"path" : "TerminologyCapabilities.purpose",
"short" : "Why this terminology capabilities is defined",
"definition" : "Explanation 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",
"base" : {
"path" : "TerminologyCapabilities.purpose",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"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",
"base" : {
"path" : "TerminologyCapabilities.copyright",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TerminologyCapabilities.kind",
"path" : "TerminologyCapabilities.kind",
"short" : "instance | capability | requirements",
"definition" : "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).",
"requirements" : "Allow searching the 3 modes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.kind",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"condition" : ["tcp-3",
"tcp-4",
"tcp-5"],
"isModifier" : false,
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatementKind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind"
}
},
{
"id" : "TerminologyCapabilities.software",
"path" : "TerminologyCapabilities.software",
"short" : "Software that is covered by this terminology capability statement",
"definition" : "Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.software",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.id",
"path" : "TerminologyCapabilities.software.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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.software.extension",
"path" : "TerminologyCapabilities.software.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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.software.modifierExtension",
"path" : "TerminologyCapabilities.software.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.software.name",
"path" : "TerminologyCapabilities.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.software.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.version",
"path" : "TerminologyCapabilities.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a version should be specified, as statements are likely to be different for different versions of software.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.software.version",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation",
"path" : "TerminologyCapabilities.implementation",
"short" : "If this describes a specific instance",
"definition" : "Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.implementation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2",
"tcp-5"],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.id",
"path" : "TerminologyCapabilities.implementation.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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.implementation.extension",
"path" : "TerminologyCapabilities.implementation.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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.implementation.modifierExtension",
"path" : "TerminologyCapabilities.implementation.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.implementation.description",
"path" : "TerminologyCapabilities.implementation.description",
"short" : "Describes this specific instance",
"definition" : "Information about the specific installation that this terminology capability statement relates to.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.implementation.description",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.url",
"path" : "TerminologyCapabilities.implementation.url",
"short" : "Base URL for the implementation",
"definition" : "An absolute base URL for the implementation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.implementation.url",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "url"
}],
"isModifier" : false,
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.lockedDate",
"path" : "TerminologyCapabilities.lockedDate",
"short" : "Whether lockedDate is supported",
"definition" : "Whether the server supports lockedDate.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.lockedDate",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"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" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (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)]))"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.modifierExtension",
"path" : "TerminologyCapabilities.codeSystem.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.uri",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]
}],
"isModifier" : false,
"isSummary" : false
},
{
"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" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.modifierExtension",
"path" : "TerminologyCapabilities.codeSystem.version.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.code",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"condition" : ["tcp-1"],
"isModifier" : false,
"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",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.isDefault",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"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",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.compositional",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.language",
"path" : "TerminologyCapabilities.codeSystem.version.language",
"short" : "Language Displays supported",
"definition" : "Language Displays supported.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.language",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter",
"path" : "TerminologyCapabilities.codeSystem.version.filter",
"short" : "Filter Properties supported",
"definition" : "Filter Properties supported.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.filter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.codeSystem.version.filter.modifierExtension",
"path" : "TerminologyCapabilities.codeSystem.version.filter.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.filter.code",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.filter.op",
"min" : 1,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.version.property",
"path" : "TerminologyCapabilities.codeSystem.version.property",
"short" : "Properties supported for $lookup",
"definition" : "Properties supported for $lookup.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.version.property",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSystem.subsumption",
"path" : "TerminologyCapabilities.codeSystem.subsumption",
"short" : "Whether subsumption is supported",
"definition" : "True if subsumption is supported for this version of the code system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.codeSystem.subsumption",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion",
"path" : "TerminologyCapabilities.expansion",
"short" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation",
"definition" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion",
"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() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.expansion.modifierExtension",
"path" : "TerminologyCapabilities.expansion.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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",
"base" : {
"path" : "TerminologyCapabilities.expansion.hierarchical",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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",
"base" : {
"path" : "TerminologyCapabilities.expansion.paging",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.incomplete",
"path" : "TerminologyCapabilities.expansion.incomplete",
"short" : "Allow request for incomplete expansions?",
"definition" : "Allow request for incomplete expansions?",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.incomplete",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.parameter",
"path" : "TerminologyCapabilities.expansion.parameter",
"short" : "Supported expansion parameter",
"definition" : "Supported expansion parameter.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "TerminologyCapabilities.expansion.parameter",
"min" : 0,
"max" : "*"
},
"type" : [{
"code" : "BackboneElement"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.parameter.id",
"path" : "TerminologyCapabilities.expansion.parameter.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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.extension",
"path" : "TerminologyCapabilities.expansion.parameter.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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.modifierExtension",
"path" : "TerminologyCapabilities.expansion.parameter.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary" : true,
"mapping" : [{
"identity" : "rim",
"map" : "N/A"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.name",
"path" : "TerminologyCapabilities.expansion.parameter.name",
"short" : "Expansion Parameter name",
"definition" : "Expansion Parameter name.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.parameter.name",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.expansion.parameter.documentation",
"path" : "TerminologyCapabilities.expansion.parameter.documentation",
"short" : "Description of support for parameter",
"definition" : "Description of support for parameter.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.expansion.parameter.documentation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "string"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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",
"base" : {
"path" : "TerminologyCapabilities.expansion.textFilter",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "markdown"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.codeSearch",
"path" : "TerminologyCapabilities.codeSearch",
"short" : "explicit | all",
"definition" : "The degree to which 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",
"base" : {
"path" : "TerminologyCapabilities.codeSearch",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "code"
}],
"isModifier" : false,
"isSummary" : false,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CodeSearchSupport"
}],
"strength" : "required",
"description" : "The degree to which the server supports the code search parameter on ValueSet, if it is supported.",
"valueSet" : "http://hl7.org/fhir/ValueSet/code-search-support"
}
},
{
"id" : "TerminologyCapabilities.validateCode",
"path" : "TerminologyCapabilities.validateCode",
"short" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation",
"definition" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.validateCode",
"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() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.validateCode.modifierExtension",
"path" : "TerminologyCapabilities.validateCode.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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",
"base" : {
"path" : "TerminologyCapabilities.validateCode.translations",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.translation",
"path" : "TerminologyCapabilities.translation",
"short" : "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation",
"definition" : "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.translation",
"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() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.translation.modifierExtension",
"path" : "TerminologyCapabilities.translation.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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",
"base" : {
"path" : "TerminologyCapabilities.translation.needsMap",
"min" : 1,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "TerminologyCapabilities.closure",
"path" : "TerminologyCapabilities.closure",
"short" : "Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation",
"definition" : "Whether the $closure operation is supported.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "TerminologyCapabilities.closure",
"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() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"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"
}],
"isModifier" : false,
"isSummary" : false,
"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. 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 can 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"
}],
"isModifier" : false,
"isSummary" : false,
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.closure.modifierExtension",
"path" : "TerminologyCapabilities.closure.modifierExtension",
"short" : "Extensions that cannot be ignored if unrecognized",
"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 in which it is contained. Usually modifier elements provide negation or qualification. 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 can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"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,
"isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"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",
"base" : {
"path" : "TerminologyCapabilities.closure.translation",
"min" : 0,
"max" : "1"
},
"type" : [{
"code" : "boolean"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"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",
"constraint" : [{
"key" : "tcp-0",
"severity" : "warning",
"human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
"xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')"
},
{
"key" : "tcp-3",
"severity" : "error",
"human" : "If kind = instance, implementation must be present and software may be present",
"expression" : "(kind != 'instance') or implementation.exists()",
"xpath" : "not(f:kind/@value='instance') or exists(f:implementation)"
},
{
"key" : "tcp-2",
"severity" : "error",
"human" : "A Capability Statement SHALL have at least one of description, software, or implementation element.",
"expression" : "(description.count() + software.count() + implementation.count()) > 0",
"xpath" : "count(f:software | f:implementation | f:description) > 0"
},
{
"key" : "tcp-5",
"severity" : "error",
"human" : "If kind = requirements, implementation and software must be absent",
"expression" : "(kind!='requirements') or (implementation.exists().not() and software.exists().not())",
"xpath" : "not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))"
},
{
"key" : "tcp-4",
"severity" : "error",
"human" : "If kind = capability, implementation must be absent, software must be present",
"expression" : "(kind != 'capability') or (implementation.exists().not() and software.exists())",
"xpath" : " not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))"
}],
"mapping" : [{
"identity" : "rim",
"map" : "n/a"
}]
},
{
"id" : "TerminologyCapabilities.url",
"path" : "TerminologyCapabilities.url",
"short" : "Canonical identifier for this terminology capabilities, represented as a URI (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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.",
"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 determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [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" : "workflow",
"map" : "Definition.url"
},
{
"identity" : "w5",
"map" : "FiveWs.identifier"
}]
},
{
"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" : "workflow",
"map" : "Definition.version"
},
{
"identity" : "w5",
"map" : "FiveWs.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 alphanumeric type name to ensure that it is machine-processing friendly.",
"requirements" : "Support human navigation and code generation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"condition" : ["inv-0"],
"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,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.title"
}]
},
{
"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 versus not.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,
"isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"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 an artifact.",
"valueSet" : "http://hl7.org/fhir/ValueSet/publication-status"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.status"
},
{
"identity" : "w5",
"map" : "FiveWs.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 capabilitiess that are appropriate for use versus not.",
"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"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.experimental"
},
{
"identity" : "w5",
"map" : "FiveWs.class"
}]
},
{
"id" : "TerminologyCapabilities.date",
"path" : "TerminologyCapabilities.date",
"short" : "Date last changed",
"definition" : "The date (and optionally time) when the terminology capabilities was published. The date must change 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" : "workflow",
"map" : "Definition.date"
},
{
"identity" : "w5",
"map" : "FiveWs.recorded"
}]
},
{
"id" : "TerminologyCapabilities.publisher",
"path" : "TerminologyCapabilities.publisher",
"short" : "Name of the publisher (organization or individual)",
"definition" : "The name of the organization or individual 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" : "workflow",
"map" : "Definition.publisher"
},
{
"identity" : "w5",
"map" : "FiveWs.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,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.contact"
}]
},
{
"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 terminology capabilities is presumed to be the predominant language in the place the terminology capabilities 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"
}],
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.description"
}]
},
{
"id" : "TerminologyCapabilities.useContext",
"path" : "TerminologyCapabilities.useContext",
"short" : "The context that 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 that all or any of the contexts apply.",
"requirements" : "Assist in searching for appropriate content.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "UsageContext"
}],
"isSummary" : true,
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.useContext"
}]
},
{
"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.",
"valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction"
},
"mapping" : [{
"identity" : "workflow",
"map" : "Definition.jurisdiction"
}]
},
{
"id" : "TerminologyCapabilities.purpose",
"path" : "TerminologyCapabilities.purpose",
"short" : "Why this terminology capabilities is defined",
"definition" : "Explanation 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" : "workflow",
"map" : "Definition.purpose"
},
{
"identity" : "w5",
"map" : "FiveWs.why[x]"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"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" : "workflow",
"map" : "Definition.copyright"
},
{
"identity" : "objimpl",
"map" : "no-gen-base"
}]
},
{
"id" : "TerminologyCapabilities.kind",
"path" : "TerminologyCapabilities.kind",
"short" : "instance | capability | requirements",
"definition" : "The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).",
"requirements" : "Allow searching the 3 modes.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}],
"condition" : ["tcp-3",
"tcp-4",
"tcp-5"],
"isSummary" : true,
"binding" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CapabilityStatementKind"
}],
"strength" : "required",
"description" : "How a capability statement is intended to be used.",
"valueSet" : "http://hl7.org/fhir/ValueSet/capability-statement-kind"
}
},
{
"id" : "TerminologyCapabilities.software",
"path" : "TerminologyCapabilities.software",
"short" : "Software that is covered by this terminology capability statement",
"definition" : "Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2"],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.name",
"path" : "TerminologyCapabilities.software.name",
"short" : "A name the software is known by",
"definition" : "Name the software is known by.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.software.version",
"path" : "TerminologyCapabilities.software.version",
"short" : "Version covered by this statement",
"definition" : "The version identifier for the software covered by this statement.",
"comment" : "If possible, a version should be specified, as statements are likely to be different for different versions of software.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation",
"path" : "TerminologyCapabilities.implementation",
"short" : "If this describes a specific instance",
"definition" : "Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "BackboneElement"
}],
"condition" : ["tcp-2",
"tcp-5"],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.description",
"path" : "TerminologyCapabilities.implementation.description",
"short" : "Describes this specific instance",
"definition" : "Information about the specific installation that this terminology capability statement relates to.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "string"
}],
"isSummary" : true
},
{
"id" : "TerminologyCapabilities.implementation.url",
"path" : "TerminologyCapabilities.implementation.url",
"short" : "Base URL for the implementation",
"definition" : "An absolute base URL for the implementation.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "url"
}],
"isSummary" : true
},
{
"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" : "canonical",
"targetProfile" : ["http://hl7.org/fhir/StructureDefinition/CodeSystem"]
}]
},
{
"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.codeSystem.subsumption",
"path" : "TerminologyCapabilities.codeSystem.subsumption",
"short" : "Whether subsumption is supported",
"definition" : "True if subsumption is supported for this version of the code system.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "boolean"
}]
},
{
"id" : "TerminologyCapabilities.expansion",
"path" : "TerminologyCapabilities.expansion",
"short" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) operation",
"definition" : "Information about the [ValueSet/$expand](valueset-operation-expand.html) 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.parameter",
"path" : "TerminologyCapabilities.expansion.parameter",
"short" : "Supported expansion parameter",
"definition" : "Supported expansion parameter.",
"min" : 0,
"max" : "*",
"type" : [{
"code" : "BackboneElement"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.name",
"path" : "TerminologyCapabilities.expansion.parameter.name",
"short" : "Expansion Parameter name",
"definition" : "Expansion Parameter name.",
"min" : 1,
"max" : "1",
"type" : [{
"code" : "code"
}]
},
{
"id" : "TerminologyCapabilities.expansion.parameter.documentation",
"path" : "TerminologyCapabilities.expansion.parameter.documentation",
"short" : "Description of support for parameter",
"definition" : "Description of support for parameter.",
"min" : 0,
"max" : "1",
"type" : [{
"code" : "string"
}]
},
{
"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 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 server supports the code search parameter on ValueSet, if it is supported.",
"valueSet" : "http://hl7.org/fhir/ValueSet/code-search-support"
}
},
{
"id" : "TerminologyCapabilities.validateCode",
"path" : "TerminologyCapabilities.validateCode",
"short" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation",
"definition" : "Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) 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 [ConceptMap/$translate](conceptmap-operation-translate.html) operation",
"definition" : "Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) 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 [ConceptMap/$closure](conceptmap-operation-closure.html) 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 Mixed Nomative/Trial Use Ballot #2 (v3.5.0-14907) generated on Sun, Aug 19, 2018 21:54+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
Ballot Comparison |
|
Propose a change