| CodeSystem | 1..1 | | A code system resource specifies a set of codes drawn from one or more code systems. |
| CodeSystem.id | 0..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| CodeSystem.meta | 0..1 | Meta | 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. |
| CodeSystem.implicitRules | 0..0 | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
| CodeSystem.language | 0..1 | code | The base language in which the resource is written. |
| CodeSystem.text | 1..1 | Narrative | 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. |
| CodeSystem.contained | 0..0 | Resource | 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. |
| CodeSystem.extension | 0..* | Extension | 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. |
| CodeSystem.modifierExtension | 0..0 | Extension | 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. |
| CodeSystem.url | 1..1 | uri | An absolute URI 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. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system. |
| CodeSystem.identifier | 1..1 | Identifier | A 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. |
| CodeSystem.identifier.id | 0..1 | string | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| CodeSystem.identifier.extension | 0..* | Extension | 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. |
| CodeSystem.identifier.use | 0..1 | code | The purpose of this identifier. |
| CodeSystem.identifier.type | 0..1 | CodeableConcept | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
| CodeSystem.identifier.system | 1..1 | uri | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
| CodeSystem.identifier.value | 1..1 | string | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
| CodeSystem.identifier.period | 0..1 | Period | Time period during which identifier is/was valid for use. |
| CodeSystem.identifier.assigner | 0..1 | Reference | Organization that issued/manages the identifier. |
| CodeSystem.version | 1..1 | string | The identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system 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. This is used in [Coding]{datatypes.html#Coding}.version. |
| CodeSystem.name | 1..1 | string | A natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| CodeSystem.title | 0..1 | string | A short, descriptive, user-friendly title for the code system. |
| CodeSystem.status | 1..1 | code | The status of this code system. Enables tracking the life-cycle of the content. |
| CodeSystem.experimental | 1..1 | boolean | A boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
| CodeSystem.date | 1..1 | dateTime | The date (and optionally time) when the code system 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 code system changes. |
| CodeSystem.publisher | 1..1 | string | The name of the individual or organization that published the code system. |
| CodeSystem.contact | 0..* | ContactDetail | Contact details to assist a user in finding and communicating with the publisher. |
| CodeSystem.contact.id | 0..1 | string | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| CodeSystem.contact.extension | 0..* | Extension | 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. |
| CodeSystem.contact.name | 0..1 | string | The name of an individual to contact. |
| CodeSystem.contact.telecom | 1..* | ContactPoint | The contact details for the individual (if a name was provided) or the organization. |
| CodeSystem.description | 1..1 | markdown | A free text natural language description of the code system from a consumer's perspective. |
| CodeSystem.useContext | 0..* | UsageContext | 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 code system instances. |
| CodeSystem.jurisdiction | 0..* | CodeableConcept | A legal or geographic region in which the code system is intended to be used. |
| CodeSystem.purpose | 0..1 | markdown | Explaination of why this code system is needed and why it has been designed as it has. |
| CodeSystem.copyright | 1..1 | markdown | 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. |
| CodeSystem.caseSensitive | 1..1 | boolean | If code comparison is case sensitive when codes within this system are compared to each other. |
| CodeSystem.valueSet | 0..1 | uri | Canonical URL of value set that contains the entire code system. |
| CodeSystem.hierarchyMeaning | 0..1 | code | The meaning of the hierarchy of concepts. |
| CodeSystem.compositional | 1..1 | boolean | True If code system defines a post-composition grammar. |
| CodeSystem.versionNeeded | 1..1 | boolean | 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. |
| CodeSystem.content | 1..1 | code | How much of the content of the code system - the concepts and codes it defines - are represented in this resource. |
| CodeSystem.count | 1..1 | unsignedInt | 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. |
| CodeSystem.filter | 0..* | BackboneElement | A filter that can be used in a value set compose statement when selecting concepts using a filter. |
| CodeSystem.filter.id | 0..1 | string | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| CodeSystem.filter.extension | 0..* | Extension | 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. |
| CodeSystem.filter.modifierExtension | 0..* | Extension | 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. |
| CodeSystem.filter.code | 1..1 | code | The code that identifies this filter when it is used in the instance. |
| CodeSystem.filter.description | 0..1 | string | A description of how or why the filter is used. |
| CodeSystem.filter.operator | 1..* | code | A list of operators that can be used with the filter. |
| CodeSystem.filter.value | 1..1 | string | A description of what the value for the filter should be. |
| CodeSystem.property | 0..* | BackboneElement | A property defines an additional slot through which additional information can be provided about a concept. |
| CodeSystem.property.id | 0..1 | string | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| CodeSystem.property.extension | 0..* | Extension | 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. |
| CodeSystem.property.modifierExtension | 0..* | Extension | 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. |
| CodeSystem.property.code | 1..1 | code | A code that is used to identify the property. The code is used internally (in CodeSystem.concept.property.code) and also externally, such as in property filters. |
| CodeSystem.property.uri | 0..1 | uri | Reference to the formal meaning of the property. One possible source of meaning is the [Concept Properties](codesystem-concept-properties.html) code system. |
| CodeSystem.property.description | 0..1 | string | A description of the property- why it is defined, and how its value might be used. |
| CodeSystem.property.type | 1..1 | code | The type of the property value. Properties of type "code" contain a code defined by the code system (e.g. a reference to anotherr defined concept). |
| CodeSystem.concept | 1..* | BackboneElement | 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. |
| CodeSystem.concept.id | 0..1 | string | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| CodeSystem.concept.extension | 0..* | Extension | 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. |
| CodeSystem.concept.modifierExtension | 0..* | Extension | 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. |
| CodeSystem.concept.code | 1..1 | code | A code - a text symbol - that uniquely identifies the concept within the code system. |
| CodeSystem.concept.display | 1..1 | string | A human readable string that is the recommended default way to present this concept to a user. |
| CodeSystem.concept.definition | 1..1 | string | 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. |
| CodeSystem.concept.designation | 0..* | BackboneElement | Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. |
| CodeSystem.concept.designation.id | 0..1 | string | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| CodeSystem.concept.designation.extension | 0..* | Extension | 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. |
| CodeSystem.concept.designation.modifierExtension | 0..* | Extension | 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. |
| CodeSystem.concept.designation.language | 0..1 | code | The language this designation is defined for. |
| CodeSystem.concept.designation.use | 1..1 | Coding | A code that details how this designation would be used. |
| CodeSystem.concept.designation.value | 1..1 | string | The text value for this designation. |
| CodeSystem.concept.property | 0..* | BackboneElement | A property value for this concept. |
| CodeSystem.concept.property.id | 0..1 | string | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| CodeSystem.concept.property.extension | 0..* | Extension | 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. |
| CodeSystem.concept.property.modifierExtension | 0..* | Extension | 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. |
| CodeSystem.concept.property.code | 1..1 | code | A code that is a reference to CodeSystem.property.code. |
| CodeSystem.concept.property.value[x] | 1..1 | [ code | Coding | string | integer | boolean | dateTime ] | The value of this property. |
| CodeSystem.concept.concept | 0..* | see CodeSystem.concept | Defines children of a concept to produce a hierarchy of concepts. The nature of the relationships is variable (is-a/contains/categorizes) - see hierarchyMeaning. |