This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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
ShareableCodeSystem
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="shareablecodesystem"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml">to do</div> </text> <url value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> <name value="Shareable CodeSystem"/> <status value="draft"/> <publisher value="HL7"/> <date value="2016-03-31T08:01:25+11:00"/> <description value="Enforces the minimum information set for the value set metadata required by HL7 and other organisations that share and publish value sets"/> <fhirVersion value="1.4.0"/> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM"/> </mapping> <kind value="resource"/> <abstract value="false"/> <baseType value="CodeSystem"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/CodeSystem"/> <derivation value="constraint"/> <snapshot> <element> <path value="CodeSystem"/> <name value="ShareableCodeSystem"/> <short value="A set of codes drawn from one or more code systems"/> <definition value="A code system resource specifies a set of codes drawn from one or more code systems."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeSystem"/> </type> <constraint> <key value="csd-1"/> <severity value="error"/> <human value="Within a code system definition, all the codes SHALL be unique"/> <expression value="descendents().code.distinct()"/> <xpath value="count(distinct-values(descendant::f:concept/f:code/@value))=count(descendant::f:concept)"/> </constraint> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="w5"/> <map value="conformance.terminology"/> </mapping> </element> <element> <path value="CodeSystem.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comments value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.meta"/> <short value="Metadata about the resource"/> <definition value="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 value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comments value="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 as much as possible."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="*"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element> <path value="CodeSystem.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comments value="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 value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="*"/> </base> <type> <code value="code"/> </type> <binding> <strength value="required"/> <description value="A human language."/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="CodeSystem.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="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 value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element> <path value="CodeSystem.contained"/> <short value="Contained, inline Resources"/> <definition value="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 value="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 value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.url"/> <short value="Globally unique logical identifier for code system (Coding.system)"/> <definition value="An absolute URL that is used to identify this code system 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 code system is (or will be) published. This is used in [Coding]{datatype s.html#Coding}.system."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.url"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element> <path value="CodeSystem.identifier"/> <short value="Additional identifier for the code system (e.g. HL7 v2 / CDA)"/> <definition value="Formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance."/> <comments value="Typically, this is used for values that can go in an HL7 v3 II data type."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.identifier"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Identifier"/> </type> <isSummary value="true"/> <mapping> <identity value="define.xml2.0"/> <map value="Identifier part"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element> <path value="CodeSystem.version"/> <short value="Logical identifier for this version (Coding.version)"/> <definition value="Used to identify this version of the code system when it is referenced in a specification, model, design or instance (e.g. Coding.version). This is an arbitrary value managed by the profile author manually and the value should be a timestamp. This is used in [Coding]{datatypes. html#Coding}.version."/> <comments value="There may be multiple resource versions of the code system that have the same identifier."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.version"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="w5"/> <map value="id.version"/> </mapping> </element> <element> <path value="CodeSystem.name"/> <short value="Informal name for this code system"/> <definition value="A free text natural language name describing the code system."/> <comments value="The name is not expected to be unique. A name should be provided unless the code system is a contained resource (e.g. an anonymous code system in a profile). Most registries will require a name."/> <requirements value="Support human navigation."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.status"/> <short value="draft | active | retired"/> <definition value="The status of the code system."/> <comments value="Allows filtering of code system instances that are appropriate (or not) for use."/> <requirements value="Identify when/if the code system should be used."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The lifecycle status of a Value Set or Concept Map."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/conformance-resource-status"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> </element> <element> <path value="CodeSystem.experimental"/> <short value="If for testing purposes, not real usage"/> <definition value="This CodeSystem was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage."/> <comments value="Allows filtering of code systems that are appropriate for use vs. not."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.experimental"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element> <path value="CodeSystem.publisher"/> <short value="Name of the publisher (organization or individual)"/> <definition value="The name of the individual or organization that published the code system."/> <comments value="Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context."/> <requirements value="Helps establish the "authority/credibility" of the code system. May also allow for contact."/> <alias value="steward"/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.publisher"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="who.witness"/> </mapping> </element> <element> <path value="CodeSystem.contact"/> <short value="Contact details of the publisher"/> <definition value="Contacts to assist a user in finding and communicating with the publisher."/> <comments value="May be a web site, an email address, a telephone number, etc."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.contact"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.contact.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.contact.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.contact.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.contact.name"/> <short value="Name of an individual to contact"/> <definition value="The name of an individual to contact regarding the code system."/> <comments value="If there is no named individual, the telecom is for the organization as a whole."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.contact.name"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.contact.telecom"/> <short value="Contact details for individual or publisher"/> <definition value="Contact details for individual (if a name was provided) or the publisher."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.contact.telecom"/> <min value="0"/> <max value="*"/> </base> <type> <code value="ContactPoint"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.date"/> <short value="Date for given status"/> <definition value="The date that the code system status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition')."/> <comments value="Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the code system. Additional specific dates may be added as extensions."/> <requirements value="Need to know when a code system was first legal for use or became withdrawn or replaced."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.date"/> <min value="0"/> <max value="1"/> </base> <type> <code value="dateTime"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> <mapping> <identity value="w5"/> <map value="when.recorded"/> </mapping> </element> <element> <path value="CodeSystem.description"/> <short value="Human language description of the code system"/> <definition value="A free text natural language description of the use of the code system - reason for definition, "the semantic space" to be included in the code system, conditions of use, etc. The description may include a list of expected usages for the code system and can also describe the approach taken to build the code system."/> <comments value="The description is not intended to describe the semantics of the Code System - 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 code system is a contained resource (e.g. an anonymous code system in a profile). Most registries will require a description."/> <requirements value="Human understandability."/> <alias value="Scope"/> <alias value="Purpose"/> <alias value="scope"/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.useContext"/> <short value="Content intends to support these contexts"/> <definition value="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 of code system definitions."/> <requirements value="Assist in searching for appropriate content."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.useContext"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <strength value="extensible"/> <description value="Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/use-context"/> </valueSetReference> </binding> <mapping> <identity value="define.xml2.0"/> <map value="COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE"/> </mapping> </element> <element> <path value="CodeSystem.requirements"/> <short value="Why needed"/> <definition value="Explains why this code system is needed and why it has been constrained as it has."/> <comments value="This element does not describe the usage of the code system (that is done in comments), rather it's for traceability of ''why'' the element is either needed or ''why'' the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.requirements"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.copyright"/> <short value="Use and/or publishing restrictions"/> <definition value="A copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system."/> <comments value="Frequently, the copyright differs between the code system and the codes that are included. The copyright statement should clearly differentiate between these when required."/> <alias value="License"/> <alias value="Restrictions"/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.copyright"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.caseSensitive"/> <short value="If code comparison is case sensitive"/> <definition value="If code comparison is case sensitive when codes within this system are compared to each other."/> <comments value="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 value="1"/> <max value="1"/> <base> <path value="CodeSystem.caseSensitive"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.valueSet"/> <short value="Canonical URL for value set with entire code system"/> <definition value="Canonical URL of value set that contains the entire code system."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.valueSet"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.compositional"/> <short value="If code system defines a post-composition grammar"/> <definition value="True If code system defines a post-composition grammar."/> <comments value="Note that the code system resource does not define what the compositional grammar is, only whether or not there is one."/> <alias value="grammar"/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.compositional"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.versionNeeded"/> <short value="If definitions are not stable"/> <definition value="This flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system."/> <comments value="Best practice is that code systems do not redefine concepts, or that if concepts are redefined, a new code system definition is created. But this is not always possible, so some code systems may be defined as 'versionNeeded'."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.versionNeeded"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.content"/> <short value="not-present | examplar | fragment | complete"/> <definition value="How much of the content of the code system - the concepts and codes it defines - are represented in this resource."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.content"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <strength value="required"/> <description value="How much of the content of the code system - the concepts and codes it defines - are represented in a code system resource"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/codesystem-content-mode"/> </valueSetReference> </binding> </element> <element> <path value="CodeSystem.count"/> <short value="Total concepts in the code system"/> <definition value="The total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts."/> <comments value="The count of concepts defined in this resource cannot be more than this value, but may be less for several reasons - see the content value."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.count"/> <min value="0"/> <max value="1"/> </base> <type> <code value="unsignedInt"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.filter"/> <short value="Filter that can be used in a value set"/> <definition value="A filter that can be used in a value set compose statement when selecting concepts using a filter."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.filter"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.filter.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.filter.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.filter.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.filter.code"/> <short value="Code that identifies the filter"/> <definition value="The code that identifies thise filter when it is used in the instance."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.filter.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.filter.description"/> <short value="How or why the filter is used"/> <definition value="A description of how or why the filter is used."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.filter.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.filter.operator"/> <short value="Operators that can be used with filter"/> <definition value="A list of operators that can be used with the filter."/> <min value="1"/> <max value="*"/> <base> <path value="CodeSystem.filter.operator"/> <min value="1"/> <max value="*"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The kind of operation to perform as a part of a property based filter."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/filter-operator"/> </valueSetReference> </binding> </element> <element> <path value="CodeSystem.filter.value"/> <short value="What to use for the value"/> <definition value="A description of what the value for the filter should be."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.filter.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.property"/> <short value="Additional information supplied about each concept"/> <definition value="A property defines an additional slot through which additional information can be provided about a concept."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.property"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.property.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.property.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.property.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.property.code"/> <short value="Identifies the property, both internally and externally"/> <definition value="A code that is used to identify the property. The code is used internally (in CodeSystem.concept.pro perty.code) and also externally, such as in property filters."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.property.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.property.description"/> <short value="Why the property is defined, and/or what it conveys"/> <definition value="A description of the property- why it is defined, and how it's value might be used."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.property.description"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <isSummary value="true"/> </element> <element> <path value="CodeSystem.property.type"/> <short value="code | Coding | string | integer | boolean | dateTime"/> <definition value="The type of the property value."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.property.type"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <isSummary value="true"/> <binding> <strength value="required"/> <description value="The type of a property value"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/concept-property-type"/> </valueSetReference> </binding> </element> <element id="concept"> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name"> <valueString value="ConceptDefinition"/> </extension> <path value="CodeSystem.concept"/> <short value="Concepts in the code system"/> <definition value="Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are."/> <comments value="If this is empty, it means that the code system resource does not represent the content of the code system."/> <min value="1"/> <max value="*"/> <base> <path value="CodeSystem.concept"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> </element> <element> <path value="CodeSystem.concept.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.concept.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.concept.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.concept.code"/> <short value="Code that identifies concept"/> <definition value="A code - a text symbol - that uniquely identifies the concept within the code system."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.concept.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> </element> <element> <path value="CodeSystem.concept.display"/> <short value="Text to display to the user"/> <definition value="A human readable string that is the recommended default way to present this concept to a user."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.concept.display"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.concept.definition"/> <short value="Formal definition"/> <definition value="The formal definition of the concept. The code system resource does not make formal definitions required, because of the prevalence of legacy systems. However, they are highly recommended, as without them there is no formal meaning associated with the concept."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.concept.definition"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.concept.designation"/> <short value="Additional representations for the concept"/> <definition value="Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc."/> <requirements value="Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.concept.designation"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> </element> <element> <path value="CodeSystem.concept.designation.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.concept.designation.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.concept.designation.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.concept.designation.language"/> <short value="Human language of the designation"/> <definition value="The language this designation is defined for."/> <comments value="In the absence of a language, the resource language applies."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.concept.designation.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <strength value="required"/> <description value="A human language."/> <valueSetUri value="http://tools.ietf.org/html/bcp47"/> </binding> </element> <element> <path value="CodeSystem.concept.designation.use"/> <short value="Details how this designation would be used"/> <definition value="A code that details how this designation would be used."/> <comments value="If no use is provided, the designation can be assumed to be suitable for general display to a human user."/> <min value="0"/> <max value="1"/> <base> <path value="CodeSystem.concept.designation.use"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Coding"/> </type> <binding> <strength value="extensible"/> <description value="Details of how a designation would be used."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/designation-use"/> </valueSetReference> </binding> </element> <element> <path value="CodeSystem.concept.designation.value"/> <short value="The text value for this designation"/> <definition value="The text value for this designation."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.concept.designation.value"/> <min value="1"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.concept.property"/> <short value="Property value for the concept"/> <definition value="A property value for this concept."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.concept.property"/> <min value="0"/> <max value="*"/> </base> <type> <code value="BackboneElement"/> </type> </element> <element> <path value="CodeSystem.concept.property.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="*"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.concept.property.extension"/> <short value="Additional Content defined by implementations"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="CodeSystem.concept.property.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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."/> <comments value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.concept.property.code"/> <short value="Reference to CodeSystem.property.code"/> <definition value="A code that is a reference to CodeSystem.property.code."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.concept.property.code"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> </element> <element> <path value="CodeSystem.concept.property.value[x]"/> <short value="Value of the property for this concept"/> <definition value="The value of this property."/> <min value="1"/> <max value="1"/> <base> <path value="CodeSystem.concept.property.value[x]"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <type> <code value="Coding"/> </type> <type> <code value="string"/> </type> <type> <code value="integer"/> </type> <type> <code value="boolean"/> </type> <type> <code value="dateTime"/> </type> </element> <element> <path value="CodeSystem.concept.concept"/> <short value="Child Concepts (is-a/contains/categorizes)"/> <definition value="Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) and can only be determined by examining the definitions of the concepts."/> <min value="0"/> <max value="*"/> <base> <path value="CodeSystem.concept.concept"/> <min value="0"/> <max value="*"/> </base> <contentReference value="#concept"/> </element> </snapshot> <differential> <element> <path value="CodeSystem"/> <name value="ShareableCodeSystem"/> <min value="1"/> <max value="1"/> <type> <code value="CodeSystem"/> </type> </element> <element> <path value="CodeSystem.immutable"/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="CodeSystem.url"/> <min value="1"/> <max value="1"/> <type> <code value="uri"/> </type> </element> <element> <path value="CodeSystem.version"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.name"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.status"/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.experimental"/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="CodeSystem.publisher"/> <alias value="steward"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.description"/> <alias value="scope"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="CodeSystem.caseSensitive"/> <min value="1"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element id="concept"> <path value="CodeSystem.concept"/> <min value="1"/> <max value="*"/> </element> <element> <path value="CodeSystem.concept.abstract"/> <min value="0"/> <max value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="CodeSystem.concept.code"/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> </element> <element> <path value="CodeSystem.concept.display"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.concept.definition"/> <min value="1"/> <max value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="CodeSystem.concept.concept"/> <min value="0"/> <max value="*"/> <contentReference value="#concept"/> </element> </differential> </StructureDefinition>