. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for valueset
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A value set specifies a set of codes drawn from one or more code systems.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet\"><b>ValueSet</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.identifier\"><b>identifier</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id to reference this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The 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 profile author manually and the value should be a timestamp.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Logical id for this version of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A free text natural language name describing the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.name\"><b>name</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Informal name for this value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The name of the individual or organization that published the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.publisher\"><b>publisher</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Name of the publisher (Organization or individual)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Contacts of the publisher to assist a user in finding and communicating with the publisher.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">Contact information of the publisher<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.description\"><b>description</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Human language description of the value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A copyright statement relating to the value set and/or its contents.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.copyright\"><b>copyright</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">About the value set or its content</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The status of the value set (this element modifies the meaning of other elements)\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-status.html\">draft | active | retired<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.experimental\"><b>experimental</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If for testing purposes, not real usage<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether this is intended to be used with an extensible binding or not.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.extensible\"><b>extensible</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether this is intended to be used with an extensible binding</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The date that the value set status was last changed.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Date for given status<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When value set defines its own codes.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define\"><b>define</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set defines its own codes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"URI to identify the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">URI to identify the code system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Version of this system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If code comparison is case sensitive when codes within this system are compared to each other.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.caseSensitive\"><b>caseSensitive</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If code comparison is case sensitive<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Concepts in the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept\"><b>concept</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Concepts in the code system --></span>\r\n <<a title=\"Code that identifies concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code that identifies concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"If this code is not for use as a real concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.abstract\"><b>abstract</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">If this code is not for use as a real concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Text to Display to the user.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Text to Display to the user</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.definition\"><b>definition</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Formal Definition</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Child Concepts (is-a / contains).\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.define.concept.concept\"><b>concept</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.define.concept</span> <span style=\"color: navy\">Child Concepts (is-a / contains)</span><span style=\"color: Gray\"> --></span></concept>\r\n </concept>\r\n </define>\r\n <<a title=\"When value set includes codes from elsewhere.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose\"><b>compose</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set includes codes from elsewhere --></span>\r\n <<a title=\"Includes the contents of the referenced value set as a part of the contents of this value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.import\"><b>import</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A value set composition SHALL have an include or an import\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: navy\">Import the contents of another value set<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Include one or more codes from a code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include\"><b>include</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A value set composition SHALL have an include or an import\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Include one or more codes from a code system<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span> --></span>\r\n <<a title=\"The code system from which the selected codes come from.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">The system the codes come from<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The version of the code system that the codes are selected from.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.version\"><b>version</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Specific version of the code system referred to<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Specifies a code or concept to be included or excluded. The list of codes is considered ordered, though the order may not have any particular significance.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: navy\">Code or concept from system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter\"><b>filter</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Select codes/concepts by their properties (including relationships) --></span>\r\n <<a title=\"A code that identifies a property defined in the code system.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.property\"><b>property</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">A property defined by the code system</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The kind of operation to perform as a part of the filter criteria.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.op\"><b>op</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"filter-operator.html\">= | is-a | is-not-a | regex | in | not in</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.include.filter.value\"><b>value</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Code from the system, or regex criteria</span><span style=\"color: Gray\"> --></span>\r\n </filter>\r\n </include>\r\n <<a title=\"Exclude one or more codes from the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.compose.exclude\"><b>exclude</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.compose.include</span> <span style=\"color: navy\">Explicitly exclude codes</span><span style=\"color: Gray\"> --></span></exclude>\r\n </compose>\r\n <<a title=\"When value set is an expansion.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion\"><b>expansion</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-5: Value set SHALL contain either a define, a compose, or an expansion element\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> When value set is an expansion --></span>\r\n <<a title=\"An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Uniquely identifies this expansion</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"Time valueset expansion happened.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.timestamp\"><b>timestamp</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#instant\">instant</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\">Time valueset expansion happened</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes in the value set.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains\"><b>contains</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Codes in the value set --></span>\r\n <<a title=\"System value for the code.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.system\"><b>system</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#uri\">uri</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">System value for the code</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Code - if blank, this is not a choosable code.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.code\"><b>code</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: SHALL have a code or a display\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">Code - if blank, this is not a choosable code</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"User display for the concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.display\"><b>display</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-6: SHALL have a code or a display\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">User display for the concept</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Codes contained in this concept.\" class=\"dict\" href=\"valueset-definitions.html#ValueSet.expansion.contains.contains\"><b>contains</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\">Content as for ValueSet.expansion.contains</span> <span style=\"color: navy\">Codes contained in this concept</span><span style=\"color: Gray\"> --></span></contains>\r\n </contains>\r\n </expansion>\r\n</ValueSet>\r\n</pre></div>"
},
"name": "valueset",
"publisher": "FHIR Project",
"description": "Basic Profile. A value set specifies a set of codes drawn from one or more code systems.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Value sets may be constructed in one of two ways: \r\n\r\n* A value set can define its own codes, and/or\r\n* A value set can be composed of codes defined in other code systems, either by listing the codes or by providing a set of selection criteria\r\nA value set can also be \"expanded\", where the value set is turned into a simple collection of enumerated codes. This operation is performed to produce a collection of codes that are ready to use for data entry or validation. An expanded value set may also contain the original definition as well.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "ValueSet",
"publish": true,
"element": [
{
"path": "ValueSet",
"definition": {
"short": "A set of codes drawn from one or more code systems",
"formal": "A value set specifies a set of codes drawn from one or more code systems.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"severity": "error",
"human": "A value set with only one import SHALL also have an include and/or an exclude unless the value set defines its own codes",
"xpath": "not(exists(f:compose)) or (count(f:compose/f:import)!=1 or exists(f:compose/f:include) or exists(f:compose/f:exclude) or exists(f:define))"
},
{
"key": "7",
"severity": "error",
"human": "A defined code system (if present) SHALL have a different identifier to the value set itself",
"xpath": "not(exists(f:define)) or (f:define/f:system/@value != f:identifier/@value)"
},
{
"key": "5",
"severity": "error",
"human": "Value set SHALL contain either a define, a compose, or an expansion element",
"xpath": "exists(f:define) or exists(f:compose) or exists(f:expansion)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.identifier",
"definition": {
"short": "Logical id to reference this value set",
"formal": "The identifier that is used to identify this value set when it is referenced in a specification, model, design or an instance (should be globally unique OID, UUID, or URI).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.version",
"definition": {
"short": "Logical id for this version of the value set",
"formal": "The 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 profile author manually and the value should be a timestamp.",
"comments": "There may be multiple resource versions of the value set that have the same identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.name",
"definition": {
"short": "Informal name for this value set",
"formal": "A free text natural language name describing the value set.",
"comments": "Not expected to be unique.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.publisher",
"definition": {
"short": "Name of the publisher (Organization or individual)",
"formal": "The name of the individual or organization that published the value set.",
"comments": "Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.telecom",
"definition": {
"short": "Contact information of the publisher",
"formal": "Contacts of the publisher to assist a user in finding and communicating with the publisher.",
"comments": "May be a web site, an email address, a telephone number (tel:), etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.description",
"definition": {
"short": "Human language description of the value set",
"formal": "A free text natural language description of the use of the value set - reason for definition, conditions of use, etc.",
"comments": "The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.copyright",
"definition": {
"short": "About the value set or its content",
"formal": "A copyright statement relating to the value set and/or its contents.",
"comments": "Frequently, the copyright differs between the value set, and codes that are included. The copyright statement should clearly differentiate between these when required.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.status",
"definition": {
"short": "draft | active | retired",
"formal": "The status of the value set.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ValueSetStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/valueset-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.experimental",
"definition": {
"short": "If for testing purposes, not real usage",
"formal": "This valueset was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.",
"comments": "Allows filtering of valuesets that are appropriate for use vs. not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.extensible",
"definition": {
"short": "Whether this is intended to be used with an extensible binding",
"formal": "Whether this is intended to be used with an extensible binding or not.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.date",
"definition": {
"short": "Date for given status",
"formal": "The date that the value set status was last changed.",
"comments": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.define",
"definition": {
"short": "When value set defines its own codes",
"formal": "When value set defines its own codes.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "3",
"severity": "error",
"human": "Within a code system definition, all the codes SHALL be unique",
"xpath": "count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"
},
{
"key": "8",
"severity": "error",
"human": "Codes must be unique",
"xpath": "count(descendant::f:concept)=count(distinct-values(descendant::f:concept/f:code/@value))"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.system",
"definition": {
"short": "URI to identify the code system",
"formal": "URI to identify the code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.version",
"definition": {
"short": "Version of this system",
"formal": "The version of this code system that defines the codes. Note that the version is optional because a well maintained code system does not suffer from versioning, and therefore the version does not need to be maintained. However many code systems are not well maintained, and the version needs to be defined and tracked.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.caseSensitive",
"definition": {
"short": "If code comparison is case sensitive",
"formal": "If code comparison is case sensitive when codes within this system are compared to each other.",
"comments": "If this value is missing, then it is not specified whether a code system is case sensitive or not. When the rule is not known, Postel's law should be followed: produce codes with the correct case, and accept codes in any case. This element is primarily provided to support validation software.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept",
"definition": {
"short": "Concepts in the code system",
"formal": "Concepts in the code system.",
"min": 0,
"max": "*",
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.code",
"definition": {
"short": "Code that identifies concept",
"formal": "Code that identifies concept.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.abstract",
"definition": {
"short": "If this code is not for use as a real concept",
"formal": "If this code is not for use as a real concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.display",
"definition": {
"short": "Text to Display to the user",
"formal": "Text to Display to the user.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.definition",
"definition": {
"short": "Formal Definition",
"formal": "The formal definition of the concept. Formal definitions are not required, because of the prevalence of legacy systems without them, but they are highly recommended, as without them there is no formal meaning associated with the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.define.concept.concept",
"definition": {
"short": "Child Concepts (is-a / contains)",
"formal": "Child Concepts (is-a / contains).",
"min": 0,
"max": "*",
"nameReference": "ValueSet.define.concept",
"isModifier": false
}
},
{
"path": "ValueSet.compose",
"definition": {
"short": "When value set includes codes from elsewhere",
"formal": "When value set includes codes from elsewhere.",
"min": 0,
"max": "1",
"constraint": [
{
"key": "1",
"severity": "error",
"human": "A value set composition SHALL have an include or an import",
"xpath": "exists(f:include) or exists(f:import)"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.import",
"definition": {
"short": "Import the contents of another value set",
"formal": "Includes the contents of the referenced value set as a part of the contents of this value set.",
"comments": "The value set URI is either a logical reference to a defined value set such as a SNOMED CT reference set, or a literal reference to a value set definition (not an expansion). If the reference is a logical one, it may not reference a actual FHIR value set resource; in this case, the referenced definition of a set of coded values needs to be clear about how versions are resolved.",
"min": 0,
"max": "*",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include",
"definition": {
"short": "Include one or more codes from a code system",
"formal": "Include one or more codes from a code system.",
"comments": "If there are no codes or filters, the entire code system is included.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.system",
"definition": {
"short": "The system the codes come from",
"formal": "The code system from which the selected codes come from.",
"comments": "See [[Coding.system]] for further documentation.",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.version",
"definition": {
"short": "Specific version of the code system referred to",
"formal": "The version of the code system that the codes are selected from.",
"comments": "This is used when selecting the descendents of a concept - they may change between versions. If no version is specified, then the exact contents of the value set may not be known until a context of use binds it to a particular version.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.code",
"definition": {
"short": "Code or concept from system",
"formal": "Specifies a code or concept to be included or excluded. The list of codes is considered ordered, though the order may not have any particular significance.",
"comments": "Expressions are allowed if defined by the underlying code system.",
"min": 0,
"max": "*",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter",
"definition": {
"short": "Select codes/concepts by their properties (including relationships)",
"formal": "Select concepts by specify a matching criteria based on the properties (including relationships) defined by the system. If multiple filters are specified, they SHALL all be true.",
"comments": "Selecting codes by specifying filters based on properties is only possible where the underlying code system defines appropriate properties. Note that in some cases, the underlying code system defines the logical concepts but not the literal codes for the concepts. In such cases, the literal definitions may be provided by a third party.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.filter.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.compose.include.filter.property",
"definition": {
"short": "A property defined by the code system",
"formal": "A code that identifies a property defined in the code system.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter.op",
"definition": {
"short": "= | is-a | is-not-a | regex | in | not in",
"formal": "The kind of operation to perform as a part of the filter criteria.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"binding": {
"name": "FilterOperator",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/filter-operator"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.include.filter.value",
"definition": {
"short": "Code from the system, or regex criteria",
"formal": "The match value may be either a code defined by the system, or a string value which is used a regex match on the literal string of the property value.",
"comments": "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.compose.exclude",
"definition": {
"short": "Explicitly exclude codes",
"formal": "Exclude one or more codes from the value set.",
"comments": "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions.",
"min": 0,
"max": "*",
"nameReference": "ValueSet.compose.include",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
},
{
"path": "ValueSet.expansion",
"definition": {
"short": "When value set is an expansion",
"formal": "When value set is an expansion.",
"min": 0,
"max": "1",
"isModifier": false
}
},
{
"path": "ValueSet.expansion.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.identifier",
"definition": {
"short": "Uniquely identifies this expansion",
"formal": "An identifier that uniquely identifies this expansion of the valueset. Systems may re-use the same identifier as long as the expansion and the definition remain the same, but are not required to do so.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.timestamp",
"definition": {
"short": "Time valueset expansion happened",
"formal": "Time valueset expansion happened.",
"min": 1,
"max": "1",
"type": [
{
"code": "instant"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains",
"definition": {
"short": "Codes in the value set",
"formal": "Codes in the value set.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "6",
"severity": "error",
"human": "SHALL have a code or a display",
"xpath": "exists(f:code) or exists(f:display)"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.system",
"definition": {
"short": "System value for the code",
"formal": "System value for the code.",
"min": 0,
"max": "1",
"type": [
{
"code": "uri"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.code",
"definition": {
"short": "Code - if blank, this is not a choosable code",
"formal": "Code - if blank, this is not a choosable code.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.display",
"definition": {
"short": "User display for the concept",
"formal": "User display for the concept.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isModifier": false
}
},
{
"path": "ValueSet.expansion.contains.contains",
"definition": {
"short": "Codes contained in this concept",
"formal": "Codes contained in this concept.",
"min": 0,
"max": "*",
"nameReference": "ValueSet.expansion.contains",
"isModifier": false
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "A code defined in the value set",
"xpath": "f:ValueSet/f:define/f:concept/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "The value set publication date",
"xpath": "f:ValueSet/f:date"
},
{
"name": "description",
"type": "string",
"documentation": "Text search in the description of the value set",
"xpath": "f:ValueSet/f:description"
},
{
"name": "identifier",
"type": "token",
"documentation": "The identifier of the value set",
"xpath": "f:ValueSet/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "The name of the value set",
"xpath": "f:ValueSet/f:name"
},
{
"name": "publisher",
"type": "string",
"documentation": "Name of the publisher of the value set",
"xpath": "f:ValueSet/f:publisher"
},
{
"name": "reference",
"type": "token",
"documentation": "A code system included or excluded in the value set or an imported value set",
"xpath": "f:ValueSet/f:compose/f:include/f:system"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the value set",
"xpath": "f:ValueSet/f:status"
},
{
"name": "system",
"type": "token",
"documentation": "The system for any codes defined by this value set",
"xpath": "f:ValueSet/f:define/f:system"
},
{
"name": "version",
"type": "token",
"documentation": "The version identifier of the value set",
"xpath": "f:ValueSet/f:version"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change