Summary
Request & Response
Diagnostics
Care Provision
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Terminology
Documents
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CanonicalResource
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
DocumentReference
Encounter
EpisodeOfCare
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
SpecimenDefinition
StructureDefinition
StructureMap
Subscription
ValueSet
default
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
TerminologyCapabilities
Path
TerminologyCapabilities
Id
TerminologyCapabilities
Cardinality
0 - *
Definition
A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
Comment
Constraint
cnl-0 [warning]
Name should be usable as an identifier for the module by machine processing applications such as code generation
tcp-2 [error]
A Terminology Capability statement SHALL have at least one of description, software, or implementation element
tcp-3 [error]
If kind = instance, implementation must be present and software may be present
tcp-4 [error]
If kind = capability, implementation must be absent, software must be present
tcp-5 [error]
If kind = requirements, implementation and software must be absent
tcp-6 [error]
Each instance of the codeSystem element must represent a distinct code system.
url
Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
Path
TerminologyCapabilities.url
Id
TerminologyCapabilities.url
Type
Cardinality
0 - 1
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 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.
The 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).
In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
Requirements
Allows the terminology capabilities to be referenced by a single globally unique identifier.
Constraint
cnl-1 [warning]
URL should not contain | or # - these characters make processing canonical references problematic
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier
Id
TerminologyCapabilities.identifier
Type
Cardinality
0 - *
Definition
A formal identifier that is used to identify this terminology capabilities when it is represented in other formats, or referenced in a specification, model, design or an instance.
Comment
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this terminology capabilities outside of FHIR, where it is not possible to use the logical URI.
Requirements
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.type.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.type.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.type.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.type.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.identifier.Identifier.type.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.identifier.Identifier.type.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
TerminologyCapabilities.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
TerminologyCapabilities.identifier.Identifier.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
TerminologyCapabilities.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.reference
Id
Reference.reference
Type
Cardinality
0 - 1
Definition
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
Comment
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
ref-1
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.type
Id
Reference.type
Type
Cardinality
0 - 1
Definition
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.
The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Comment
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.
Binding
Strength
extensible
Description
Aa resource (or, for logical models, the URI of the logical model).
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.identifier
Id
Reference.identifier
Type
Cardinality
0 - 1
Definition
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
Comment
When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.
When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
This element only allows for a single identifier. In the case where additional identifers are required, use the [http://hl7.org/fhir/StructureDefinition/additionalIdentifier](http://hl7.org/fhir/extensions/StructureDefinition-additionalIdentifier.html) extension.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.identifier.Identifier.use
Id
Identifier.use
Type
Cardinality
0 - 1
Definition
The purpose of this identifier.
Comment
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Requirements
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Binding
Strength
required
Description
Identifies the purpose for this identifier, if known .
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.identifier.Identifier.type
Id
Identifier.type
Type
Cardinality
0 - 1
Definition
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Comment
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Requirements
Allows users to make use of identifiers when the identifier system is not known.
Binding
Strength
extensible
Description
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.identifier.Identifier.system
Id
Identifier.system
Type
Cardinality
0 - 1
Definition
Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
Comment
Identifier.system is always case sensitive.
Requirements
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.identifier.Identifier.value
Id
Identifier.value
Type
Cardinality
0 - 1
Definition
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Comment
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [http://hl7.org/fhir/StructureDefinition/rendered-value](http://hl7.org/fhir/extensions/StructureDefinition-rendered-value.html)). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ident-1
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.identifier.Identifier.period
Id
Identifier.period
Type
Cardinality
0 - 1
Definition
Time period during which identifier is/was valid for use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.identifier.Identifier.assigner
Id
Identifier.assigner
Type
Cardinality
0 - 1
Definition
Organization that issued/manages the identifier.
Comment
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.identifier.Identifier.assigner.Reference.display
Id
Reference.display
Type
Cardinality
0 - 1
Definition
Plain text narrative that identifies the resource in addition to the resource reference.
Comment
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
ref-2
Path
TerminologyCapabilities.version
Id
TerminologyCapabilities.version
Type
Cardinality
0 - 1
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]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.versionAlgorithm[x]
Id
TerminologyCapabilities.versionAlgorithm[x]
Type
Cardinality
0 - 1
Definition
Indicates the mechanism used to compare versions to determine which is more current.
Comment
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.name
Id
TerminologyCapabilities.name
Type
Cardinality
0 - 1
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cnl-0
Path
TerminologyCapabilities.title
Id
TerminologyCapabilities.title
Type
Cardinality
0 - 1
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.status
Id
TerminologyCapabilities.status
Type
Cardinality
1 - 1
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.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Binding
Strength
required
Description
The lifecycle status of an artifact.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.experimental
Id
TerminologyCapabilities.experimental
Type
Cardinality
0 - 1
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.date
Id
TerminologyCapabilities.date
Type
Cardinality
1 - 1
Definition
The date (and optionally time) when the terminology capabilities was last significantly changed. 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
The date is often not tracked until the resource is published, but may be present on draft content. 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.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.publisher
Id
TerminologyCapabilities.publisher
Type
Cardinality
0 - 1
Definition
The name of the organization or individual responsible for the release and ongoing maintenance of 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.contact
Id
TerminologyCapabilities.contact
Type
Cardinality
0 - *
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.
See guidance around (not) making local changes to elements [here](canonicalresource.html#localization).
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.contact.ContactDetail.name
Id
ContactDetail.name
Type
Cardinality
0 - 1
Definition
The name of an individual to contact.
Comment
If there is no named individual, the telecom information is for the organization as a whole.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.contact.ContactDetail.telecom
Id
ContactDetail.telecom
Type
Cardinality
0 - *
Definition
The contact details for the individual (if a name was provided) or the organization.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.contact.ContactDetail.telecom.ContactPoint.system
Id
ContactPoint.system
Type
Cardinality
0 - 1
Definition
Telecommunications form for contact point - what communications system is required to make use of the contact.
Comment
Binding
Strength
required
Description
Telecommunications form for contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
TerminologyCapabilities.contact.ContactDetail.telecom.ContactPoint.value
Id
ContactPoint.value
Type
Cardinality
0 - 1
Definition
The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
Comment
Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
Requirements
Need to support legacy numbers that are not in a tightly controlled format.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cpt-2
Path
TerminologyCapabilities.contact.ContactDetail.telecom.ContactPoint.use
Id
ContactPoint.use
Type
Cardinality
0 - 1
Definition
Identifies the purpose for the contact point.
Comment
Applications can assume that a contact is current unless it explicitly says that it is temporary or old.
Requirements
Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.
Binding
Strength
required
Description
Use of contact point.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.contact.ContactDetail.telecom.ContactPoint.rank
Id
ContactPoint.rank
Type
Cardinality
0 - 1
Definition
Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
Comment
Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
Ranks need not be unique. E.g. it's possible to have multiple contacts with rank=1. If the ranks have different systems or uses, this would be interpreted to mean "X is my most preferred phone number, Y is my most preferred email address" or "X is my preferred home email and Y is my preferred work email". If the system and use for equally-ranked contacts are the same, then the level of preference is equivalent for both repetitions.
Ranks need not be sequential and not all repetitions must have a rank. For example, it's possible to have 4 contacts with ranks of 2, 5 and two with no rank specified. That would be interpreted to mean the first is preferred over the second and no preference stated for the remaining contacts.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.contact.ContactDetail.telecom.ContactPoint.period
Id
ContactPoint.period
Type
Cardinality
0 - 1
Definition
Time period when the contact point was/is in use.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.contact.ContactDetail.telecom.ContactPoint.period.Period.start
Id
Period.start
Type
Cardinality
0 - 1
Definition
The start of the period. The boundary is inclusive.
Comment
If the low element is missing, the meaning is that the low boundary is not known.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
TerminologyCapabilities.contact.ContactDetail.telecom.ContactPoint.period.Period.end
Id
Period.end
Type
Cardinality
0 - 1
Definition
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Comment
The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
per-1
Path
TerminologyCapabilities.description
Id
TerminologyCapabilities.description
Type
Cardinality
0 - 1
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 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-2
Path
TerminologyCapabilities.useContext
Id
TerminologyCapabilities.useContext
Type
Cardinality
0 - *
Definition
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and 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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.code
Id
UsageContext.code
Type
Cardinality
1 - 1
Definition
A code that identifies the type of context being specified by this usage context.
Comment
Binding
Strength
extensible
Description
A code that specifies a type of context being specified by a usage context.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.useContext.UsageContext.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.useContext.UsageContext.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.value[x]
Id
UsageContext.value[x]
Type
Cardinality
1 - 1
Definition
A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
Comment
Binding
Strength
example
Description
A code that defines the specific value for the context being specified.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.value[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.useContext.UsageContext.value[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.jurisdiction
Id
TerminologyCapabilities.jurisdiction
Type
Cardinality
0 - *
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.
DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Binding
Strength
extensible
Description
Countries and regions within which this artifact is targeted for use.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.jurisdiction.CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.jurisdiction.CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.jurisdiction.CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.jurisdiction.CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.jurisdiction.CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
cod-1
Path
TerminologyCapabilities.jurisdiction.CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.purpose
Id
TerminologyCapabilities.purpose
Type
Cardinality
0 - 1
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.copyright
Id
TerminologyCapabilities.copyright
Type
Cardinality
0 - 1
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.
Comment
Requirements
Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.copyrightLabel
Id
TerminologyCapabilities.copyrightLabel
Type
Cardinality
0 - 1
Definition
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
Comment
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Requirements
Defines the content expected to be rendered in all representations of the artifact.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.kind
Id
TerminologyCapabilities.kind
Type
Cardinality
1 - 1
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).
Comment
Requirements
Allow searching the 3 modes.
Binding
Strength
required
Description
How a capability statement is intended to be used.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-3
tcp-5
tcp-4
Path
TerminologyCapabilities.software
Id
TerminologyCapabilities.software
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-2
tcp-5
tcp-4
Path
TerminologyCapabilities.software.name
Id
TerminologyCapabilities.software.name
Type
Cardinality
1 - 1
Definition
Name the software is known by.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.software.version
Id
TerminologyCapabilities.software.version
Type
Cardinality
0 - 1
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.implementation
Id
TerminologyCapabilities.implementation
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-3
tcp-2
tcp-5
tcp-4
Path
TerminologyCapabilities.implementation.description
Id
TerminologyCapabilities.implementation.description
Type
Cardinality
1 - 1
Definition
Information about the specific installation that this terminology capability statement relates to.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.implementation.url
Id
TerminologyCapabilities.implementation.url
Type
Cardinality
0 - 1
Definition
An absolute base URL for the implementation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.lockedDate
Id
TerminologyCapabilities.lockedDate
Type
Cardinality
0 - 1
Definition
Whether the server supports lockedDate.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSystem
Id
TerminologyCapabilities.codeSystem
Type
Cardinality
0 - *
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 its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
tcp-1 [error]
If there is more than one version, a version code must be defined
tcp-7 [error]
Each version.code element must be distinct for a particular code system.
tcp-8 [error]
A codeSystem element instance may have at most one version.isDefault element with a value of 'true'.
Condition
tcp-6
Path
TerminologyCapabilities.codeSystem.uri
Id
TerminologyCapabilities.codeSystem.uri
Type
Cardinality
0 - 1
Definition
Canonical identifier for the code system, represented as a URI.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-6
Path
TerminologyCapabilities.codeSystem.version
Id
TerminologyCapabilities.codeSystem.version
Type
Cardinality
0 - *
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-1
tcp-7
tcp-8
Path
TerminologyCapabilities.codeSystem.version.code
Id
TerminologyCapabilities.codeSystem.version.code
Type
Cardinality
0 - 1
Definition
For version-less code systems, there should be a single version with no identifier.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-1
tcp-7
Path
TerminologyCapabilities.codeSystem.version.isDefault
Id
TerminologyCapabilities.codeSystem.version.isDefault
Type
Cardinality
0 - 1
Definition
If this is the default version for this code system.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Condition
tcp-8
Path
TerminologyCapabilities.codeSystem.version.compositional
Id
TerminologyCapabilities.codeSystem.version.compositional
Type
Cardinality
0 - 1
Definition
If the compositional grammar defined by the code system is supported.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSystem.version.filter
Id
TerminologyCapabilities.codeSystem.version.filter
Type
Cardinality
0 - *
Definition
Filter Properties supported.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSystem.version.filter.code
Id
TerminologyCapabilities.codeSystem.version.filter.code
Type
Cardinality
1 - 1
Definition
Code of the property supported.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSystem.version.filter.op
Id
TerminologyCapabilities.codeSystem.version.filter.op
Type
Cardinality
1 - *
Definition
Operations supported for the property.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSystem.version.property
Id
TerminologyCapabilities.codeSystem.version.property
Type
Cardinality
0 - *
Definition
Properties supported for $lookup.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSystem.content
Id
TerminologyCapabilities.codeSystem.content
Type
Cardinality
1 - 1
Definition
The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
Comment
Binding
Strength
required
Description
The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSystem.subsumption
Id
TerminologyCapabilities.codeSystem.subsumption
Type
Cardinality
0 - 1
Definition
True if subsumption is supported for this version of the code system.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
expansion
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
Path
TerminologyCapabilities.expansion
Id
TerminologyCapabilities.expansion
Type
Cardinality
0 - 1
Definition
Information about the [ValueSet/$expand](valueset-operation-expand.html) operation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.expansion.hierarchical
Id
TerminologyCapabilities.expansion.hierarchical
Type
Cardinality
0 - 1
Definition
Whether the server can return nested value sets.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.expansion.paging
Id
TerminologyCapabilities.expansion.paging
Type
Cardinality
0 - 1
Definition
Whether the server supports paging on expansion.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.expansion.incomplete
Id
TerminologyCapabilities.expansion.incomplete
Type
Cardinality
0 - 1
Definition
True if requests for incomplete expansions are allowed.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.expansion.parameter
Id
TerminologyCapabilities.expansion.parameter
Type
Cardinality
0 - *
Definition
Supported expansion parameter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.expansion.parameter.name
Id
TerminologyCapabilities.expansion.parameter.name
Type
Cardinality
1 - 1
Definition
Name of the supported expansion parameter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.expansion.parameter.documentation
Id
TerminologyCapabilities.expansion.parameter.documentation
Type
Cardinality
0 - 1
Definition
Description of support for parameter.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.expansion.textFilter
Id
TerminologyCapabilities.expansion.textFilter
Type
Cardinality
0 - 1
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.codeSearch
Id
TerminologyCapabilities.codeSearch
Type
Cardinality
0 - 1
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.
Binding
Strength
required
Description
The degree to which the server supports the code search parameter on ValueSet, if it is supported.
ValueSet
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
validateCode
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
Path
TerminologyCapabilities.validateCode
Id
TerminologyCapabilities.validateCode
Type
Cardinality
0 - 1
Definition
Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.validateCode.translations
Id
TerminologyCapabilities.validateCode.translations
Type
Cardinality
1 - 1
Definition
Whether translations are validated.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
translation
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
Path
TerminologyCapabilities.translation
Id
TerminologyCapabilities.translation
Type
Cardinality
0 - 1
Definition
Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.translation.needsMap
Id
TerminologyCapabilities.translation.needsMap
Type
Cardinality
1 - 1
Definition
Whether the client must identify the map.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
closure
Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
Path
TerminologyCapabilities.closure
Id
TerminologyCapabilities.closure
Type
Cardinality
0 - 1
Definition
Whether the $closure operation is supported.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
TerminologyCapabilities.closure.translation
Id
TerminologyCapabilities.closure.translation
Type
Cardinality
0 - 1
Definition
If cross-system closure is supported.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children