Skip to main content

ValueSet

PropertyValue
Publisher
NameValueSet
URLhttp://hl7.org/fhir/StructureDefinition/ValueSet
Statusactive
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
ValueSet0..*ValueSetA ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between CodeSystem definitions and their use in coded elements.
ValueSet.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ValueSet.meta0..1MetaThe 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.
ValueSet.implicitRules0..1uriA 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.
ValueSet.language0..1codeThe base language in which the resource is written.
ValueSet.text0..1NarrativeA 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.
ValueSet.contained0..*ResourceThese 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.
ValueSet.extension0..*ExtensionMay 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.
ValueSet.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.url0..1uriAn absolute URI that is used to identify this value set 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 value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.
ValueSet.identifier0..*IdentifierA formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.
ValueSet.version0..1stringThe identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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.
ValueSet.name0..1stringA natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.
ValueSet.title0..1stringA short, descriptive, user-friendly title for the value set.
ValueSet.status1..1codeThe status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.
ValueSet.experimental0..1booleanA Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
ValueSet.date0..1dateTimeThe date (and optionally time) when the value set was created or revised (e.g. the 'content logical definition').
ValueSet.publisher0..1stringThe name of the organization or individual that published the value set.
ValueSet.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
ValueSet.description0..1markdownA free text natural language description of the value set from a consumer's perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.
ValueSet.useContext0..*UsageContextThe 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 value set instances.
ValueSet.jurisdiction0..*CodeableConceptA legal or geographic region in which the value set is intended to be used.
ValueSet.immutable0..1booleanIf this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
ValueSet.purpose0..1markdownExplanation of why this value set is needed and why it has been designed as it has.
ValueSet.copyright0..1markdownA copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
ValueSet.compose0..1BackboneElementA set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).
ValueSet.compose.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.extension0..*ExtensionMay 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.
ValueSet.compose.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.compose.lockedDate0..1dateThe Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.
ValueSet.compose.inactive0..1booleanWhether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).
ValueSet.compose.include1..*BackboneElementInclude one or more codes from a code system or other value set(s).
ValueSet.compose.include.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.extension0..*ExtensionMay 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.
ValueSet.compose.include.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.compose.include.system0..1uriAn absolute URI which is the code system from which the selected codes come from.
ValueSet.compose.include.version0..1stringThe version of the code system that the codes are selected from, or the special version '*' for all versions.
ValueSet.compose.include.concept0..*BackboneElementSpecifies a concept to be included or excluded.
ValueSet.compose.include.concept.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.concept.extension0..*ExtensionMay 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.
ValueSet.compose.include.concept.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.compose.include.concept.code1..1codeSpecifies a code for the concept to be included or excluded.
ValueSet.compose.include.concept.display0..1stringThe text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system.
ValueSet.compose.include.concept.designation0..*BackboneElementAdditional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.
ValueSet.compose.include.concept.designation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.concept.designation.extension0..*ExtensionMay 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.
ValueSet.compose.include.concept.designation.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.compose.include.concept.designation.language0..1codeThe language this designation is defined for.
ValueSet.compose.include.concept.designation.use0..1CodingA code that represents types of uses of designations.
ValueSet.compose.include.concept.designation.value1..1stringThe text value for this designation.
ValueSet.compose.include.filter0..*BackboneElementSelect concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true.
ValueSet.compose.include.filter.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.compose.include.filter.extension0..*ExtensionMay 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.
ValueSet.compose.include.filter.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.compose.include.filter.property1..1codeA code that identifies a property or a filter defined in the code system.
ValueSet.compose.include.filter.op1..1codeThe kind of operation to perform as a part of the filter criteria.
ValueSet.compose.include.filter.value1..1stringThe match value may be either a code defined by the system, or a string value, which is a regex match on the literal string of the property value (if the filter represents a property defined in CodeSystem) or of the system filter value (if the filter represents a filter defined in CodeSystem) when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.
ValueSet.compose.include.valueSet0..*canonicalSelects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets.
ValueSet.compose.exclude0..*ValueSetExclude one or more codes from the value set based on code system filters and/or other value sets.
ValueSet.expansion0..1BackboneElementA value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.
ValueSet.expansion.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.expansion.extension0..*ExtensionMay 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.
ValueSet.expansion.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.expansion.identifier0..1uriAn identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier.
ValueSet.expansion.timestamp1..1dateTimeThe time at which the expansion was produced by the expanding system.
ValueSet.expansion.total0..1integerThe total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter.
ValueSet.expansion.offset0..1integerIf paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present.
ValueSet.expansion.parameter0..*BackboneElementA parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion.
ValueSet.expansion.parameter.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.expansion.parameter.extension0..*ExtensionMay 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.
ValueSet.expansion.parameter.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.expansion.parameter.name1..1stringName of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process.
ValueSet.expansion.parameter.value[x]0..1stringThe value of the parameter.
ValueSet.expansion.contains0..*BackboneElementThe codes that are contained in the value set expansion.
ValueSet.expansion.contains.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ValueSet.expansion.contains.extension0..*ExtensionMay 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.
ValueSet.expansion.contains.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ValueSet.expansion.contains.system0..1uriAn absolute URI which is the code system in which the code for this item in the expansion is defined.
ValueSet.expansion.contains.abstract0..1booleanIf true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.
ValueSet.expansion.contains.inactive0..1booleanIf the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use).
ValueSet.expansion.contains.version0..1stringThe version of the code system from this code was taken. 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.
ValueSet.expansion.contains.code0..1codeThe code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set.
ValueSet.expansion.contains.display0..1stringThe recommended display for this item in the expansion.
ValueSet.expansion.contains.designation0..*ValueSetAdditional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation.
ValueSet.expansion.contains.contains0..*ValueSetOther codes and entries contained under this entry in the hierarchy.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
contexttokenMultiple Resources: * CapabilityStatement: A use context assigned to the capability statement* CodeSystem: A use context assigned to the code system* CompartmentDefinition: A use context assigned to the compartment definition* ConceptMap: A use context assigned to the concept map* GraphDefinition: A use context assigned to the graph definition* ImplementationGuide: A use context assigned to the implementation guide* MessageDefinition: A use context assigned to the message definition* NamingSystem: A use context assigned to the naming system* OperationDefinition: A use context assigned to the operation definition* SearchParameter: A use context assigned to the search parameter* StructureDefinition: A use context assigned to the structure definition* StructureMap: A use context assigned to the structure map* TerminologyCapabilities: A use context assigned to the terminology capabilities* ValueSet: A use context assigned to the value set(CapabilityStatement.useContext.value.ofType(CodeableConcept)) / (CodeSystem.useContext.value.ofType(CodeableConcept)) / (CompartmentDefinition.useContext.value.ofType(CodeableConcept)) / (ConceptMap.useContext.value.ofType(CodeableConcept)) / (GraphDefinition.useContext.value.ofType(CodeableConcept)) / (ImplementationGuide.useContext.value.ofType(CodeableConcept)) / (MessageDefinition.useContext.value.ofType(CodeableConcept)) / (NamingSystem.useContext.value.ofType(CodeableConcept)) / (OperationDefinition.useContext.value.ofType(CodeableConcept)) / (SearchParameter.useContext.value.ofType(CodeableConcept)) / (StructureDefinition.useContext.value.ofType(CodeableConcept)) / (StructureMap.useContext.value.ofType(CodeableConcept)) / (TerminologyCapabilities.useContext.value.ofType(CodeableConcept)) / (ValueSet.useContext.value.ofType(CodeableConcept))
context-quantityquantityMultiple Resources: * CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement* CodeSystem: A quantity- or range-valued use context assigned to the code system* CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition* ConceptMap: A quantity- or range-valued use context assigned to the concept map* GraphDefinition: A quantity- or range-valued use context assigned to the graph definition* ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide* MessageDefinition: A quantity- or range-valued use context assigned to the message definition* NamingSystem: A quantity- or range-valued use context assigned to the naming system* OperationDefinition: A quantity- or range-valued use context assigned to the operation definition* SearchParameter: A quantity- or range-valued use context assigned to the search parameter* StructureDefinition: A quantity- or range-valued use context assigned to the structure definition* StructureMap: A quantity- or range-valued use context assigned to the structure map* TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities* ValueSet: A quantity- or range-valued use context assigned to the value set(CapabilityStatement.useContext.value.ofType(Quantity)) / (CapabilityStatement.useContext.value.ofType(Range)) / (CodeSystem.useContext.value.ofType(Quantity)) / (CodeSystem.useContext.value.ofType(Range)) / (CompartmentDefinition.useContext.value.ofType(Quantity)) / (CompartmentDefinition.useContext.value.ofType(Range)) / (ConceptMap.useContext.value.ofType(Quantity)) / (ConceptMap.useContext.value.ofType(Range)) / (GraphDefinition.useContext.value.ofType(Quantity)) / (GraphDefinition.useContext.value.ofType(Range)) / (ImplementationGuide.useContext.value.ofType(Quantity)) / (ImplementationGuide.useContext.value.ofType(Range)) / (MessageDefinition.useContext.value.ofType(Quantity)) / (MessageDefinition.useContext.value.ofType(Range)) / (NamingSystem.useContext.value.ofType(Quantity)) / (NamingSystem.useContext.value.ofType(Range)) / (OperationDefinition.useContext.value.ofType(Quantity)) / (OperationDefinition.useContext.value.ofType(Range)) / (SearchParameter.useContext.value.ofType(Quantity)) / (SearchParameter.useContext.value.ofType(Range)) / (StructureDefinition.useContext.value.ofType(Quantity)) / (StructureDefinition.useContext.value.ofType(Range)) / (StructureMap.useContext.value.ofType(Quantity)) / (StructureMap.useContext.value.ofType(Range)) / (TerminologyCapabilities.useContext.value.ofType(Quantity)) / (TerminologyCapabilities.useContext.value.ofType(Range)) / (ValueSet.useContext.value.ofType(Quantity)) / (ValueSet.useContext.value.ofType(Range))
context-typetokenMultiple Resources: * CapabilityStatement: A type of use context assigned to the capability statement* CodeSystem: A type of use context assigned to the code system* CompartmentDefinition: A type of use context assigned to the compartment definition* ConceptMap: A type of use context assigned to the concept map* GraphDefinition: A type of use context assigned to the graph definition* ImplementationGuide: A type of use context assigned to the implementation guide* MessageDefinition: A type of use context assigned to the message definition* NamingSystem: A type of use context assigned to the naming system* OperationDefinition: A type of use context assigned to the operation definition* SearchParameter: A type of use context assigned to the search parameter* StructureDefinition: A type of use context assigned to the structure definition* StructureMap: A type of use context assigned to the structure map* TerminologyCapabilities: A type of use context assigned to the terminology capabilities* ValueSet: A type of use context assigned to the value setCapabilityStatement.useContext.code / CodeSystem.useContext.code / CompartmentDefinition.useContext.code / ConceptMap.useContext.code / GraphDefinition.useContext.code / ImplementationGuide.useContext.code / MessageDefinition.useContext.code / NamingSystem.useContext.code / OperationDefinition.useContext.code / SearchParameter.useContext.code / StructureDefinition.useContext.code / StructureMap.useContext.code / TerminologyCapabilities.useContext.code / ValueSet.useContext.code
datedateMultiple Resources: * CapabilityStatement: The capability statement publication date* CodeSystem: The code system publication date* CompartmentDefinition: The compartment definition publication date* ConceptMap: The concept map publication date* GraphDefinition: The graph definition publication date* ImplementationGuide: The implementation guide publication date* MessageDefinition: The message definition publication date* NamingSystem: The naming system publication date* OperationDefinition: The operation definition publication date* SearchParameter: The search parameter publication date* StructureDefinition: The structure definition publication date* StructureMap: The structure map publication date* TerminologyCapabilities: The terminology capabilities publication date* ValueSet: The value set publication dateCapabilityStatement.date / CodeSystem.date / CompartmentDefinition.date / ConceptMap.date / GraphDefinition.date / ImplementationGuide.date / MessageDefinition.date / NamingSystem.date / OperationDefinition.date / SearchParameter.date / StructureDefinition.date / StructureMap.date / TerminologyCapabilities.date / ValueSet.date
descriptionstringMultiple Resources: * CapabilityStatement: The description of the capability statement* CodeSystem: The description of the code system* CompartmentDefinition: The description of the compartment definition* ConceptMap: The description of the concept map* GraphDefinition: The description of the graph definition* ImplementationGuide: The description of the implementation guide* MessageDefinition: The description of the message definition* NamingSystem: The description of the naming system* OperationDefinition: The description of the operation definition* SearchParameter: The description of the search parameter* StructureDefinition: The description of the structure definition* StructureMap: The description of the structure map* TerminologyCapabilities: The description of the terminology capabilities* ValueSet: The description of the value setCapabilityStatement.description / CodeSystem.description / CompartmentDefinition.description / ConceptMap.description / GraphDefinition.description / ImplementationGuide.description / MessageDefinition.description / NamingSystem.description / OperationDefinition.description / SearchParameter.description / StructureDefinition.description / StructureMap.description / TerminologyCapabilities.description / ValueSet.description
jurisdictiontokenMultiple Resources: * CapabilityStatement: Intended jurisdiction for the capability statement* CodeSystem: Intended jurisdiction for the code system* ConceptMap: Intended jurisdiction for the concept map* GraphDefinition: Intended jurisdiction for the graph definition* ImplementationGuide: Intended jurisdiction for the implementation guide* MessageDefinition: Intended jurisdiction for the message definition* NamingSystem: Intended jurisdiction for the naming system* OperationDefinition: Intended jurisdiction for the operation definition* SearchParameter: Intended jurisdiction for the search parameter* StructureDefinition: Intended jurisdiction for the structure definition* StructureMap: Intended jurisdiction for the structure map* TerminologyCapabilities: Intended jurisdiction for the terminology capabilities* ValueSet: Intended jurisdiction for the value setCapabilityStatement.jurisdiction / CodeSystem.jurisdiction / ConceptMap.jurisdiction / GraphDefinition.jurisdiction / ImplementationGuide.jurisdiction / MessageDefinition.jurisdiction / NamingSystem.jurisdiction / OperationDefinition.jurisdiction / SearchParameter.jurisdiction / StructureDefinition.jurisdiction / StructureMap.jurisdiction / TerminologyCapabilities.jurisdiction / ValueSet.jurisdiction
namestringMultiple Resources: * CapabilityStatement: Computationally friendly name of the capability statement* CodeSystem: Computationally friendly name of the code system* CompartmentDefinition: Computationally friendly name of the compartment definition* ConceptMap: Computationally friendly name of the concept map* GraphDefinition: Computationally friendly name of the graph definition* ImplementationGuide: Computationally friendly name of the implementation guide* MessageDefinition: Computationally friendly name of the message definition* NamingSystem: Computationally friendly name of the naming system* OperationDefinition: Computationally friendly name of the operation definition* SearchParameter: Computationally friendly name of the search parameter* StructureDefinition: Computationally friendly name of the structure definition* StructureMap: Computationally friendly name of the structure map* TerminologyCapabilities: Computationally friendly name of the terminology capabilities* ValueSet: Computationally friendly name of the value setCapabilityStatement.name / CodeSystem.name / CompartmentDefinition.name / ConceptMap.name / GraphDefinition.name / ImplementationGuide.name / MessageDefinition.name / NamingSystem.name / OperationDefinition.name / SearchParameter.name / StructureDefinition.name / StructureMap.name / TerminologyCapabilities.name / ValueSet.name
publisherstringMultiple Resources: * CapabilityStatement: Name of the publisher of the capability statement* CodeSystem: Name of the publisher of the code system* CompartmentDefinition: Name of the publisher of the compartment definition* ConceptMap: Name of the publisher of the concept map* GraphDefinition: Name of the publisher of the graph definition* ImplementationGuide: Name of the publisher of the implementation guide* MessageDefinition: Name of the publisher of the message definition* NamingSystem: Name of the publisher of the naming system* OperationDefinition: Name of the publisher of the operation definition* SearchParameter: Name of the publisher of the search parameter* StructureDefinition: Name of the publisher of the structure definition* StructureMap: Name of the publisher of the structure map* TerminologyCapabilities: Name of the publisher of the terminology capabilities* ValueSet: Name of the publisher of the value setCapabilityStatement.publisher / CodeSystem.publisher / CompartmentDefinition.publisher / ConceptMap.publisher / GraphDefinition.publisher / ImplementationGuide.publisher / MessageDefinition.publisher / NamingSystem.publisher / OperationDefinition.publisher / SearchParameter.publisher / StructureDefinition.publisher / StructureMap.publisher / TerminologyCapabilities.publisher / ValueSet.publisher
statustokenMultiple Resources: * CapabilityStatement: The current status of the capability statement* CodeSystem: The current status of the code system* CompartmentDefinition: The current status of the compartment definition* ConceptMap: The current status of the concept map* GraphDefinition: The current status of the graph definition* ImplementationGuide: The current status of the implementation guide* MessageDefinition: The current status of the message definition* NamingSystem: The current status of the naming system* OperationDefinition: The current status of the operation definition* SearchParameter: The current status of the search parameter* StructureDefinition: The current status of the structure definition* StructureMap: The current status of the structure map* TerminologyCapabilities: The current status of the terminology capabilities* ValueSet: The current status of the value setCapabilityStatement.status / CodeSystem.status / CompartmentDefinition.status / ConceptMap.status / GraphDefinition.status / ImplementationGuide.status / MessageDefinition.status / NamingSystem.status / OperationDefinition.status / SearchParameter.status / StructureDefinition.status / StructureMap.status / TerminologyCapabilities.status / ValueSet.status
titlestringMultiple Resources: * CapabilityStatement: The human-friendly name of the capability statement* CodeSystem: The human-friendly name of the code system* ConceptMap: The human-friendly name of the concept map* ImplementationGuide: The human-friendly name of the implementation guide* MessageDefinition: The human-friendly name of the message definition* OperationDefinition: The human-friendly name of the operation definition* StructureDefinition: The human-friendly name of the structure definition* StructureMap: The human-friendly name of the structure map* TerminologyCapabilities: The human-friendly name of the terminology capabilities* ValueSet: The human-friendly name of the value setCapabilityStatement.title / CodeSystem.title / ConceptMap.title / ImplementationGuide.title / MessageDefinition.title / OperationDefinition.title / StructureDefinition.title / StructureMap.title / TerminologyCapabilities.title / ValueSet.title
urluriMultiple Resources: * CapabilityStatement: The uri that identifies the capability statement* CodeSystem: The uri that identifies the code system* CompartmentDefinition: The uri that identifies the compartment definition* ConceptMap: The uri that identifies the concept map* GraphDefinition: The uri that identifies the graph definition* ImplementationGuide: The uri that identifies the implementation guide* MessageDefinition: The uri that identifies the message definition* OperationDefinition: The uri that identifies the operation definition* SearchParameter: The uri that identifies the search parameter* StructureDefinition: The uri that identifies the structure definition* StructureMap: The uri that identifies the structure map* TerminologyCapabilities: The uri that identifies the terminology capabilities* ValueSet: The uri that identifies the value setCapabilityStatement.url / CodeSystem.url / CompartmentDefinition.url / ConceptMap.url / GraphDefinition.url / ImplementationGuide.url / MessageDefinition.url / OperationDefinition.url / SearchParameter.url / StructureDefinition.url / StructureMap.url / TerminologyCapabilities.url / ValueSet.url
versiontokenMultiple Resources: * CapabilityStatement: The business version of the capability statement* CodeSystem: The business version of the code system* CompartmentDefinition: The business version of the compartment definition* ConceptMap: The business version of the concept map* GraphDefinition: The business version of the graph definition* ImplementationGuide: The business version of the implementation guide* MessageDefinition: The business version of the message definition* OperationDefinition: The business version of the operation definition* SearchParameter: The business version of the search parameter* StructureDefinition: The business version of the structure definition* StructureMap: The business version of the structure map* TerminologyCapabilities: The business version of the terminology capabilities* ValueSet: The business version of the value setCapabilityStatement.version / CodeSystem.version / CompartmentDefinition.version / ConceptMap.version / GraphDefinition.version / ImplementationGuide.version / MessageDefinition.version / OperationDefinition.version / SearchParameter.version / StructureDefinition.version / StructureMap.version / TerminologyCapabilities.version / ValueSet.version
context-type-quantitycompositeMultiple Resources: * CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement* CodeSystem: A use context type and quantity- or range-based value assigned to the code system* CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition* ConceptMap: A use context type and quantity- or range-based value assigned to the concept map* GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition* ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide* MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition* NamingSystem: A use context type and quantity- or range-based value assigned to the naming system* OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition* SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter* StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition* StructureMap: A use context type and quantity- or range-based value assigned to the structure map* TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities* ValueSet: A use context type and quantity- or range-based value assigned to the value setCapabilityStatement.useContext / CodeSystem.useContext / CompartmentDefinition.useContext / ConceptMap.useContext / GraphDefinition.useContext / ImplementationGuide.useContext / MessageDefinition.useContext / NamingSystem.useContext / OperationDefinition.useContext / SearchParameter.useContext / StructureDefinition.useContext / StructureMap.useContext / TerminologyCapabilities.useContext / ValueSet.useContext
context-type-valuecompositeMultiple Resources: * CapabilityStatement: A use context type and value assigned to the capability statement* CodeSystem: A use context type and value assigned to the code system* CompartmentDefinition: A use context type and value assigned to the compartment definition* ConceptMap: A use context type and value assigned to the concept map* GraphDefinition: A use context type and value assigned to the graph definition* ImplementationGuide: A use context type and value assigned to the implementation guide* MessageDefinition: A use context type and value assigned to the message definition* NamingSystem: A use context type and value assigned to the naming system* OperationDefinition: A use context type and value assigned to the operation definition* SearchParameter: A use context type and value assigned to the search parameter* StructureDefinition: A use context type and value assigned to the structure definition* StructureMap: A use context type and value assigned to the structure map* TerminologyCapabilities: A use context type and value assigned to the terminology capabilities* ValueSet: A use context type and value assigned to the value setCapabilityStatement.useContext / CodeSystem.useContext / CompartmentDefinition.useContext / ConceptMap.useContext / GraphDefinition.useContext / ImplementationGuide.useContext / MessageDefinition.useContext / NamingSystem.useContext / OperationDefinition.useContext / SearchParameter.useContext / StructureDefinition.useContext / StructureMap.useContext / TerminologyCapabilities.useContext / ValueSet.useContext
identifiertokenMultiple Resources: * CodeSystem: External identifier for the code system* ConceptMap: External identifier for the concept map* MessageDefinition: External identifier for the message definition* StructureDefinition: External identifier for the structure definition* StructureMap: External identifier for the structure map* ValueSet: External identifier for the value setCodeSystem.identifier / ConceptMap.identifier / MessageDefinition.identifier / StructureDefinition.identifier / StructureMap.identifier / ValueSet.identifier
codetokenThis special parameter searches for codes in the value set. See additional notes on the ValueSet resourceValueSet.expansion.contains.code / ValueSet.compose.include.concept.code
expansionuriIdentifies the value set expansion (business identifier)ValueSet.expansion.identifier
referenceuriA code system included or excluded in the value set or an imported value setValueSet.compose.include.system