FHIR Release 3 (STU)
TerminologyThis page is part of the FHIR Specification (v3.0.2: STU 3). 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
StructureDefinition for Enforces the minimum information set for the value set metadata required by HL7 and other organisations that share and publish value sets
{
"resourceType": "StructureDefinition",
"id": "shareablevalueset",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/shareablevalueset",
"name": "Shareable ValueSet",
"status": "draft",
"experimental": false,
"date": "2019-10-24T11:53:00+11:00",
"publisher": "HL7",
"description": "Enforces the minimum information set for the value set metadata required by HL7 and other organisations that share and publish value sets",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "define.xml2.0",
"uri": "http://www.cdisc.org/define-xml",
"name": "CDISC Define XML 2.0 metadata standard"
},
{
"identity": "objimpl",
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information"
}
],
"kind": "resource",
"abstract": false,
"type": "ValueSet",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ValueSet",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "ValueSet",
"path": "ValueSet",
"short": "A set of codes drawn from one or more code systems",
"definition": "A value set specifies a set of codes drawn from one or more code systems.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "vsd-5",
"severity": "error",
"human": "Value set SHALL contain at least one of a compose or an expansion element",
"expression": "compose.exists() or expansion.exists()",
"xpath": "exists(f:compose) or exists(f:expansion)",
"source": "ValueSet"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "conformance.terminology"
}
]
},
{
"id": "ValueSet.id",
"path": "ValueSet.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "ValueSet.meta",
"path": "ValueSet.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "ValueSet.implicitRules",
"path": "ValueSet.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "ValueSet.language",
"path": "ValueSet.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ValueSet.text",
"path": "ValueSet.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "ValueSet.contained",
"path": "ValueSet.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.extension",
"path": "ValueSet.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.modifierExtension",
"path": "ValueSet.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.url",
"path": "ValueSet.url",
"short": "Logical URI to reference this value set (globally unique)",
"definition": "An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).",
"comment": "Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.",
"requirements": "Allows the value set to be referenced by a single globally unique identifier.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.url",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ValueSet.identifier",
"path": "ValueSet.identifier",
"short": "Additional identifier for the value set",
"definition": "A 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.",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this value set outside of FHIR, where it is not possible to use the logical URI.",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "define.xml2.0",
"map": "Identifier part"
},
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "ValueSet.version",
"path": "ValueSet.version",
"short": "Business version of the value set",
"definition": "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 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.",
"comment": "There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the value set with the format [url]|[version].",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "id.version"
}
]
},
{
"id": "ValueSet.name",
"path": "ValueSet.name",
"short": "Name for this value set (computer friendly)",
"definition": "A 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.",
"comment": "The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. A name should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a name.",
"requirements": "Support human navigation and code generation.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ValueSet.title",
"path": "ValueSet.title",
"short": "Name for this value set (human friendly)",
"definition": "A short, descriptive, user-friendly title for the value set.",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "ValueSet.status",
"path": "ValueSet.status",
"short": "draft | active | retired | unknown",
"definition": "The status of this value set. Enables tracking the life-cycle of the content.",
"comment": "Allows filtering of value sets that are appropriate for use vs. not. \nThis is labeled as \"Is Modifier\" because applications should not use a retired value set without due consideration.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "required",
"description": "The lifecycle status of a Value Set or Concept Map.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/publication-status"
}
},
"mapping": [
{
"identity": "w5",
"map": "status"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.experimental",
"path": "ValueSet.experimental",
"short": "For testing purposes, not real usage",
"definition": "A 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.",
"comment": "Allows filtering of value set that are appropriate for use vs. not. This is labeled as \"Is Modifier\" because applications should not use an experimental value set in production.",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level value set.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.experimental",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "ValueSet.date",
"path": "ValueSet.date",
"short": "Date this was last changed",
"definition": "The date (and optionally time) when the value set was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the value set changes. (e.g. the 'content logical definition').",
"comment": "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. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
"alias": [
"Revision Date"
],
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.date",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "ValueSet.publisher",
"path": "ValueSet.publisher",
"short": "Name of the publisher (organization or individual)",
"definition": "The name of the individual or organization that published the value set.",
"comment": "Usually an organization, but may be an individual. The publisher (or steward) of the value set is the organization or individual primarily responsible for the maintenance and upkeep of the value set. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.",
"requirements": "Helps establish the \"authority/credibility\" of the value set. May also allow for contact.",
"alias": [
"steward"
],
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.publisher",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "who.witness"
}
]
},
{
"id": "ValueSet.contact",
"path": "ValueSet.contact",
"short": "Contact details for the publisher",
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"comment": "May be a web site, an email address, a telephone number, etc.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.contact",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactDetail"
}
],
"isSummary": true
},
{
"id": "ValueSet.description",
"path": "ValueSet.description",
"short": "Natural language description of the value set",
"definition": "A free text natural language description of the value set from a consumer's perspective.",
"comment": "This description can be used to capture details such as why the value set was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the value set as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created). 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. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description.",
"alias": [
"Scope",
"Purpose",
"scope"
],
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.useContext",
"path": "ValueSet.useContext",
"short": "Context the content is intended to support",
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate value set instances.",
"comment": "When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.useContext",
"min": 0,
"max": "*"
},
"type": [
{
"code": "UsageContext"
}
],
"isSummary": true
},
{
"id": "ValueSet.jurisdiction",
"path": "ValueSet.jurisdiction",
"short": "Intended jurisdiction for value set (if applicable)",
"definition": "A legal or geographic region in which the value set is intended to be used.",
"comment": "It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.jurisdiction",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "Countries and regions within which this artifact is targeted for use",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/jurisdiction"
}
}
},
{
"id": "ValueSet.immutable",
"path": "ValueSet.immutable",
"short": "Indicates whether or not any change to the content logical definition may occur",
"definition": "If this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.",
"comment": "Normally immutability is set to 'false', which is the default assumption if it is not populated. Note that the implication is that if this is set to 'true', there may be only one ValueSet version for this definition. Immutability tends to be set to 'true' in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example \"All specializations of ACT in ActClassCode\" - Where there's no safe way to express the \"Purpose\" such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.immutable",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "ValueSet.purpose",
"path": "ValueSet.purpose",
"short": "Why this value set is defined",
"definition": "Explaination of why this value set is needed and why it has been designed as it has.",
"comment": "This element does not describe the usage of the value set Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.purpose",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "ValueSet.copyright",
"path": "ValueSet.copyright",
"short": "Use and/or publishing restrictions",
"definition": "A 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.",
"comment": "null Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the value set and/or its content.",
"alias": [
"License",
"Restrictions"
],
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.copyright",
"min": 0,
"max": "1"
},
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "objimpl",
"map": "no-gen-base"
}
]
},
{
"id": "ValueSet.extensible",
"path": "ValueSet.extensible",
"short": "Whether this is intended to be used with an extensible binding",
"definition": "Whether this is intended to be used with an extensible binding or not.",
"requirements": "It is not required to say whether this intent applies.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.extensible",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "ValueSet.compose",
"path": "ValueSet.compose",
"short": "Definition of the content of the value set (CLD)",
"definition": "A set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the \"Content Logical Definition\" (CLD).",
"alias": [
"Content Logical Definition"
],
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.compose",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"vsd-5"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "ValueSet.compose.id",
"path": "ValueSet.compose.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.extension",
"path": "ValueSet.compose.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.modifierExtension",
"path": "ValueSet.compose.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.lockedDate",
"path": "ValueSet.compose.lockedDate",
"short": "Fixed date for version-less references (transitive)",
"definition": "If a locked date is defined, then the Content Logical Definition must be evaluated using the current version as of the locked date for referenced code system(s) and value set instances where ValueSet.compose.include.version is not defined.",
"comment": "With a defined lockedDate the value set is considered \"Locked\". Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.compose.lockedDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "ValueSet.compose.inactive",
"path": "ValueSet.compose.inactive",
"short": "Whether inactive codes are in the value set",
"definition": "Whether 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 ExpansionProfile (but generally, inactive codes would be expected to be included).",
"comment": "Note that in the FHIR terminology framework, \"deprecated\" does not mean inactive, but in some code systems (e.g. LOINC, deprecated means inactive). Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.compose.inactive",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"isSummary": true
},
{
"id": "ValueSet.compose.include",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ConceptSet"
}
],
"path": "ValueSet.compose.include",
"short": "Include one or more codes from a code system or other value set(s)",
"definition": "Include one or more codes from a code system or other value set(s).",
"comment": "All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is 'include all the codes that meet all these conditions'.",
"min": 1,
"max": "*",
"base": {
"path": "ValueSet.compose.include",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "vsd-2",
"severity": "error",
"human": "A value set with concepts or filters SHALL include a system",
"expression": "(concept.exists() or filter.exists()) implies system.exists()",
"xpath": "not(exists(f:concept) or exists(f:filter)) or exists(f:system)"
},
{
"key": "vsd-3",
"severity": "error",
"human": "Cannot have both concept and filter",
"expression": "concept.empty() or filter.empty()",
"xpath": "not(exists(f:concept)) or not(exists(f:filter))"
},
{
"key": "vsd-1",
"severity": "error",
"human": "A value set include/exclude SHALL have a value set or a system",
"expression": "valueSet.exists() or system.exists()",
"xpath": "exists(f:valueSet) or exists(f:system)"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.id",
"path": "ValueSet.compose.include.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.extension",
"path": "ValueSet.compose.include.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.modifierExtension",
"path": "ValueSet.compose.include.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.system",
"path": "ValueSet.compose.include.system",
"short": "The system the codes come from",
"definition": "An absolute URI which is the code system from which the selected codes come from.",
"comment": "If there are no codes or filters, the entire code system is included. Note that the set of codes that are included may contain abstract codes. See ''Coding.system'' for further documentation about the correct value for the system element.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.compose.include.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"vsd-1",
"vsd-2"
],
"isSummary": true,
"mapping": [
{
"identity": "define.xml2.0",
"map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Href"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.version",
"path": "ValueSet.compose.include.version",
"short": "Specific version of the code system referred to",
"definition": "The version of the code system that the codes are selected from.",
"comment": "This is used when selecting the descendants 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",
"base": {
"path": "ValueSet.compose.include.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "define.xml2.0",
"map": "ODM/Study/MetaDataVersion/CodeList/ExternalCodeList/Version"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.concept",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ConceptReference"
}
],
"path": "ValueSet.compose.include.concept",
"short": "A concept defined in the system",
"definition": "Specifies a concept to be included or excluded.",
"comment": "The list of concepts is considered ordered, though the order may not have any particular significance. Typically, the order of an expansion follows that defined in the compose element.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.compose.include.concept",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"vsd-3"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.concept.id",
"path": "ValueSet.compose.include.concept.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.concept.extension",
"path": "ValueSet.compose.include.concept.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.concept.modifierExtension",
"path": "ValueSet.compose.include.concept.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.concept.code",
"path": "ValueSet.compose.include.concept.code",
"short": "Code or expression from system",
"definition": "Specifies a code for the concept to be included or excluded.",
"comment": "Expressions are allowed if defined by the underlying code system.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.compose.include.concept.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.concept.display",
"path": "ValueSet.compose.include.concept.display",
"short": "Text to display for this code for this value set in this valueset",
"definition": "The 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.",
"comment": "The value set resource allows for an alternative display to be specified for when this concept is used in this particular value set. See notes in the value set narrative about the correct use of this element.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.compose.include.concept.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.concept.designation",
"path": "ValueSet.compose.include.concept.designation",
"short": "Additional representations for this concept",
"definition": "Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.compose.include.concept.designation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "ValueSet.compose.include.concept.designation.id",
"path": "ValueSet.compose.include.concept.designation.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.concept.designation.extension",
"path": "ValueSet.compose.include.concept.designation.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.concept.designation.modifierExtension",
"path": "ValueSet.compose.include.concept.designation.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.concept.designation.language",
"path": "ValueSet.compose.include.concept.designation.language",
"short": "Human language of the designation",
"definition": "The language this designation is defined for.",
"comment": "In the absence of a language, the resource language applies.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.compose.include.concept.designation.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "ValueSet.compose.include.concept.designation.use",
"path": "ValueSet.compose.include.concept.designation.use",
"short": "Details how this designation would be used",
"definition": "A code that details how this designation would be used.",
"comment": "If no use is provided, the designation can be assumed to be suitable for general display to a human user.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.compose.include.concept.designation.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ConceptDesignationUse"
}
],
"strength": "extensible",
"description": "Details of how a designation would be used.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/designation-use"
}
}
},
{
"id": "ValueSet.compose.include.concept.designation.value",
"path": "ValueSet.compose.include.concept.designation.value",
"short": "The text value for this designation",
"definition": "The text value for this designation.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.compose.include.concept.designation.value",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ValueSet.compose.include.filter",
"path": "ValueSet.compose.include.filter",
"short": "Select codes/concepts by their properties (including relationships)",
"definition": "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.",
"comment": "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": "*",
"base": {
"path": "ValueSet.compose.include.filter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"vsd-3"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.filter.id",
"path": "ValueSet.compose.include.filter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.filter.extension",
"path": "ValueSet.compose.include.filter.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.compose.include.filter.modifierExtension",
"path": "ValueSet.compose.include.filter.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.filter.property",
"path": "ValueSet.compose.include.filter.property",
"short": "A property defined by the code system",
"definition": "A code that identifies a property defined in the code system.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.compose.include.filter.property",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.filter.op",
"path": "ValueSet.compose.include.filter.op",
"short": "= | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists",
"definition": "The kind of operation to perform as a part of the filter criteria.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.compose.include.filter.op",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FilterOperator"
}
],
"strength": "required",
"description": "The kind of operation to perform as a part of a property based filter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/filter-operator"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.filter.value",
"path": "ValueSet.compose.include.filter.value",
"short": "Code from the system, or regex criteria, or boolean value for exists",
"definition": "The 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 when the operation is 'regex', or one of the values (true and false), when the operation is 'exists'.",
"comment": "Use regex matching with care - full regex matching on every SNOMED CT term is prohibitive, for example.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.compose.include.filter.value",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.include.valueSet",
"path": "ValueSet.compose.include.valueSet",
"short": "Select only contents included in this value set",
"definition": "Selects concepts found in this value set. This is an absolute URI that is a reference to ValueSet.url.",
"comment": "The value set URI is either a logical reference to a defined value set such as a [SNOMED CT reference set]{snomedct.html#implicit}, or a direct reference to a value set definition using ValueSet.url. The reference may not refer to an actual FHIR ValueSet resource; in this case, whatever is referred to is an implicit definition of a value set that needs to be clear about how versions are resolved.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.compose.include.valueSet",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"vsd-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.compose.exclude",
"path": "ValueSet.compose.exclude",
"short": "Explicitly exclude codes from a code system or other value sets",
"definition": "Exclude one or more codes from the value set based on code system filters and/or other value sets.",
"comment": "Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.compose.exclude",
"min": 0,
"max": "*"
},
"contentReference": "#ValueSet.compose.include",
"condition": [
"vsd-2"
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.expansion",
"path": "ValueSet.expansion",
"short": "Used when the value set is \"expanded\"",
"definition": "A 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.",
"comment": "Expansion is performed to produce a collection of codes that are ready to use for data entry or validation.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"vsd-5"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "ValueSet.expansion.id",
"path": "ValueSet.expansion.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.expansion.extension",
"path": "ValueSet.expansion.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.expansion.modifierExtension",
"path": "ValueSet.expansion.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.expansion.identifier",
"path": "ValueSet.expansion.identifier",
"short": "Uniquely identifies this expansion",
"definition": "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.",
"comment": "Typically, this uri is a UUID (e.g. urn:uuid:8230ff20-c97a-4167-a59d-dc2cb9df16dd).",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.expansion.identifier",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "ValueSet.expansion.timestamp",
"path": "ValueSet.expansion.timestamp",
"short": "Time ValueSet expansion happened",
"definition": "The time at which the expansion was produced by the expanding system.",
"comment": "This SHOULD be a fully populated instant, but in some circumstances, value sets are expanded by hand, and the expansion is published without that precision.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.expansion.timestamp",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "ValueSet.expansion.total",
"path": "ValueSet.expansion.total",
"short": "Total number of codes in the expansion",
"definition": "The 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.",
"comment": "Paging only applies to flat expansions.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.total",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "ValueSet.expansion.offset",
"path": "ValueSet.expansion.offset",
"short": "Offset at which this resource starts",
"definition": "If 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.",
"comment": "Paging only applies to flat expansions. If a filter is applied, the count is the number of concepts that matched the filter, not the number of concepts in an unfiltered view of the expansion.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.offset",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
],
"meaningWhenMissing": "Paging is not being used"
},
{
"id": "ValueSet.expansion.parameter",
"path": "ValueSet.expansion.parameter",
"short": "Parameter that controlled the expansion process",
"definition": "A 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.",
"comment": "The server decides which parameters to include here, but at a minimum, the list SHOULD include the date, filter, and profile parameters passed to the $expand operation (if any).",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.expansion.parameter",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
},
{
"id": "ValueSet.expansion.parameter.id",
"path": "ValueSet.expansion.parameter.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.expansion.parameter.extension",
"path": "ValueSet.expansion.parameter.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.expansion.parameter.modifierExtension",
"path": "ValueSet.expansion.parameter.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.expansion.parameter.name",
"path": "ValueSet.expansion.parameter.name",
"short": "Name as assigned by the server",
"definition": "The name of the parameter.",
"comment": "The names are assigned at the discretion of the server.",
"min": 1,
"max": "1",
"base": {
"path": "ValueSet.expansion.parameter.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ValueSet.expansion.parameter.value[x]",
"path": "ValueSet.expansion.parameter.value[x]",
"short": "Value of the named parameter",
"definition": "The value of the parameter.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.parameter.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
},
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "uri"
},
{
"code": "code"
}
]
},
{
"id": "ValueSet.expansion.contains",
"path": "ValueSet.expansion.contains",
"short": "Codes in the value set",
"definition": "The codes that are contained in the value set expansion.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.expansion.contains",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "vsd-6",
"severity": "error",
"human": "SHALL have a code or a display",
"expression": "code.exists() or display.exists()",
"xpath": "exists(f:code) or exists(f:display)"
},
{
"key": "vsd-9",
"severity": "error",
"human": "Must have a code if not abstract",
"expression": "code.exists() or abstract = true",
"xpath": "exists(f:code) or (f:abstract/@value = true())"
},
{
"key": "vsd-10",
"severity": "error",
"human": "Must have a system if a code is present",
"expression": "code.empty() or system.exists()",
"xpath": "exists(f:system) or not(exists(f:code))"
}
]
},
{
"id": "ValueSet.expansion.contains.id",
"path": "ValueSet.expansion.contains.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.expansion.contains.extension",
"path": "ValueSet.expansion.contains.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "ValueSet.expansion.contains.modifierExtension",
"path": "ValueSet.expansion.contains.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.expansion.contains.system",
"path": "ValueSet.expansion.contains.system",
"short": "System value for the code",
"definition": "An absolute URI which is the code system in which the code for this item in the expansion is defined.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.contains.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
]
},
{
"id": "ValueSet.expansion.contains.abstract",
"path": "ValueSet.expansion.contains.abstract",
"short": "If user cannot select this entry",
"definition": "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value.",
"comment": "This should not be understood to exclude its use for searching (e.g. by subsumption testing). The client should know whether it is appropriate for the user to select an abstract code or not.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.contains.abstract",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false
},
{
"id": "ValueSet.expansion.contains.inactive",
"path": "ValueSet.expansion.contains.inactive",
"short": "If concept is inactive in the code system",
"definition": "If 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.",
"comment": "This should only have a value if the concept is inactive.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.contains.inactive",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false
},
{
"id": "ValueSet.expansion.contains.version",
"path": "ValueSet.expansion.contains.version",
"short": "Version in which this code/display is defined",
"definition": "The version of this code system that defined this code and/or display. This should only be used with code systems that do not enforce concept permanence.",
"comment": "The exact value of the version string is specified by the system from which the code is derived.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.contains.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "ValueSet.expansion.contains.code",
"path": "ValueSet.expansion.contains.code",
"short": "Code - if blank, this is not a selectable code",
"definition": "The 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.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.contains.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"vsd-6"
]
},
{
"id": "ValueSet.expansion.contains.display",
"path": "ValueSet.expansion.contains.display",
"short": "User display for the concept",
"definition": "The recommended display for this item in the expansion.",
"min": 0,
"max": "1",
"base": {
"path": "ValueSet.expansion.contains.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"vsd-6"
]
},
{
"id": "ValueSet.expansion.contains.designation",
"path": "ValueSet.expansion.contains.designation",
"short": "Additional representations for this item",
"definition": "Additional 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.",
"comment": "The designations provided must be based on the value set and code system definitions.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.expansion.contains.designation",
"min": 0,
"max": "*"
},
"contentReference": "#ValueSet.compose.include.concept.designation"
},
{
"id": "ValueSet.expansion.contains.contains",
"path": "ValueSet.expansion.contains.contains",
"short": "Codes contained under this entry",
"definition": "Other codes and entries contained under this entry in the hierarchy.",
"comment": "If the expansion uses this element, there is no implication about the logical relationship between them, and the structure cannot be used for logical inferencing. The structure exists to provide navigational assistance for helping human users to locate codes in the expansion.",
"min": 0,
"max": "*",
"base": {
"path": "ValueSet.expansion.contains.contains",
"min": 0,
"max": "*"
},
"contentReference": "#ValueSet.expansion.contains"
}
]
},
"differential": {
"element": [
{
"id": "ValueSet",
"path": "ValueSet",
"min": 1,
"max": "1"
},
{
"id": "ValueSet.url",
"path": "ValueSet.url",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
]
},
{
"id": "ValueSet.version",
"path": "ValueSet.version",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ValueSet.name",
"path": "ValueSet.name",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ValueSet.status",
"path": "ValueSet.status",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.experimental",
"path": "ValueSet.experimental",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "ValueSet.publisher",
"path": "ValueSet.publisher",
"alias": [
"steward"
],
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "ValueSet.description",
"path": "ValueSet.description",
"alias": [
"scope"
],
"min": 1,
"max": "1",
"type": [
{
"code": "markdown"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "ValueSet.immutable",
"path": "ValueSet.immutable",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
}
]
}
}
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change