Data Model Libraries
    Preparing search index...

    Class CodeSystem

    CodeSystem Class

    The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.

    FHIR Specification

    • Short: Declares the existence of and describes a code system or code system supplement
    • Definition: The CodeSystem resource is used to declare the existence of and describe a code system or code system supplement and its key properties, and optionally define a part or all of its content.
    • FHIR Version: 5.0.0

    FHIR CodeSystem

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? versionAlgorithm? name? title? publicationStatusEnum status experimental? date? publisher? contact? description? useContext? jurisdiction? purpose? copyright? copyrightLabel? approvalDate? lastReviewDate? effectivePeriod? topic? author? editor? reviewer? endorser? relatedArtifact? caseSensitive? valueSet? codesystemHierarchyMeaningEnum hierarchyMeaning? compositional? versionNeeded? codesystemContentModeEnum content supplements? count? filter? property? concept?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getVersionAlgorithm setVersionAlgorithm hasVersionAlgorithm getVersionAlgorithmStringType hasVersionAlgorithmStringType getVersionAlgorithmCoding hasVersionAlgorithmCoding getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getCopyrightLabelElement setCopyrightLabelElement hasCopyrightLabelElement getCopyrightLabel setCopyrightLabel hasCopyrightLabel getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getTopic setTopic addTopic hasTopic getAuthor setAuthor addAuthor hasAuthor getEditor setEditor addEditor hasEditor getReviewer setReviewer addReviewer hasReviewer getEndorser setEndorser addEndorser hasEndorser getRelatedArtifact setRelatedArtifact addRelatedArtifact hasRelatedArtifact getCaseSensitiveElement setCaseSensitiveElement hasCaseSensitiveElement getCaseSensitive setCaseSensitive hasCaseSensitive getValueSetElement setValueSetElement hasValueSetElement getValueSet setValueSet hasValueSet getHierarchyMeaningEnumType setHierarchyMeaningEnumType hasHierarchyMeaningEnumType getHierarchyMeaningElement setHierarchyMeaningElement hasHierarchyMeaningElement getHierarchyMeaning setHierarchyMeaning hasHierarchyMeaning getCompositionalElement setCompositionalElement hasCompositionalElement getCompositional setCompositional hasCompositional getVersionNeededElement setVersionNeededElement hasVersionNeededElement getVersionNeeded setVersionNeeded hasVersionNeeded getContentEnumType setContentEnumType hasContentEnumType getContentElement setContentElement hasContentElement getContent setContent hasContent getSupplementsElement setSupplementsElement hasSupplementsElement getSupplements setSupplements hasSupplements getCountElement setCountElement hasCountElement getCount setCount hasCount getFilter setFilter addFilter hasFilter getProperty setProperty addProperty hasProperty getConcept setConcept addConcept hasConcept fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContact initUseContext initJurisdiction initTopic initAuthor initEditor initReviewer initEndorser initRelatedArtifact initFilter initProperty initConcept

    Constructors

    Properties

    url?: UriType

    CodeSystem.url Element

    FHIR Specification

    • Short: Canonical identifier for this code system, represented as a URI (globally unique) (Coding.system)
    • Definition: An absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this code system is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the code system is stored on different servers. This is used in Coding.system.
    • 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. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the code system to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    CodeSystem.identifier Element

    FHIR Specification

    • Short: Additional identifier for the code system (business identifier)
    • Definition: 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.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this code system outside of FHIR, where it is not possible to use the logical URI. Note that HL7 defines at least three identifiers for many of its code systems - the FHIR canonical URL, the OID and the V2 Table 0396 mnemonic code.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    CodeSystem.version Element

    FHIR Specification

    • Short: Business version of the code system (Coding.version)
    • Definition: 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.version.
    • Comment: There may be different code system instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the code system with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionAlgorithm?: IDataType

    CodeSystem.versionAlgorithm[x] Element

    @ChoiceDataTypesMeta('CodeSystem.versionAlgorithm[x]', ['string','Coding',]

    FHIR Specification

    • Short: How to compare versions
    • Definition: Indicates the mechanism used to compare versions to determine which CodeSystem is more current.
    • Comment: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
    • FHIR Types: 'string', 'Coding',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    CodeSystem.name Element

    FHIR Specification

    • Short: Name for this code system (computer friendly)
    • Definition: 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.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    CodeSystem.title Element

    FHIR Specification

    • Short: Name for this code system (human friendly)
    • Definition: A short, descriptive, user-friendly title for the code system.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    CodeSystem.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this code system. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of code systems that are appropriate for use versus not. See guidance around (not) making local changes to elements here.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired CodeSystem without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    CodeSystem.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: 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.
    • Comment: Allows filtering of code systems that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level code system.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date?: DateTimeType

    CodeSystem.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the code system was last significantly changed. The date must change 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.
    • Comment: The date is often not tracked until the resource is published, but may be present on draft content. 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 or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    CodeSystem.publisher Element

    FHIR Specification

    • Short: Name of the publisher/steward (organization or individual)
    • Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the code system.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the code system is the organization or individual primarily responsible for the maintenance and upkeep of the code system. 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 code system. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the code system. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    CodeSystem.contact Element

    FHIR Specification

    • 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. See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    CodeSystem.description Element

    FHIR Specification

    • Short: Natural language description of the code system
    • Definition: A free text natural language description of the code system from a consumer's perspective.
    • Comment: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the code system 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 code system is presumed to be the predominant language in the place the code system was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    CodeSystem.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate code system instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    CodeSystem.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for code system (if applicable)
    • Definition: A legal or geographic region in which the code system is intended to be used.
    • Comment: It may be possible for the code system to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    CodeSystem.purpose Element

    FHIR Specification

    • Short: Why this code system is defined
    • Definition: Explanation of why this code system is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the code system. 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 code system.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    CodeSystem.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: 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.
    • Comment: ... Sometimes, the copyright differs between the code system 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 code system and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyrightLabel?: StringType

    CodeSystem.copyrightLabel Element

    FHIR Specification

    • Short: Copyright holder and year(s)
    • Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
    • Comment: The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
    • Requirements: Defines the content expected to be rendered in all representations of the artifact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    CodeSystem.approvalDate Element

    FHIR Specification

    • Short: When the CodeSystem was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. See guidance around (not) making local changes to elements here.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    CodeSystem.lastReviewDate Element

    FHIR Specification

    • Short: When the CodeSystem was last reviewed by the publisher
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date. See guidance around (not) making local changes to elements here.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    CodeSystem.effectivePeriod Element

    FHIR Specification

    • Short: When the CodeSystem is expected to be used
    • Definition: The period during which the CodeSystem content was or is planned to be in active use.
    • Comment: The effective period for a CodeSystem determines when the content is applicable for usage and is independent of publication and review dates. For example, a system intended to be used for the year 2016 might be published in 2015. See guidance around (not) making local changes to elements here.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the CodeSystem are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    topic?: CodeableConcept[]

    CodeSystem.topic Element

    FHIR Specification

    • Short: E.g. Education, Treatment, Assessment, etc
    • Definition: Descriptions related to the content of the CodeSystem. Topics provide a high-level categorization as well as keywords for the CodeSystem that can be useful for filtering and searching.
    • Comment: DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)
    • Requirements: Repositories must be able to determine how to categorize the CodeSystem so that it can be found by topical and keyword searches.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    author?: ContactDetail[]

    CodeSystem.author Element

    FHIR Specification

    • Short: Who authored the CodeSystem
    • Definition: An individiual or organization primarily involved in the creation and maintenance of the CodeSystem.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    editor?: ContactDetail[]

    CodeSystem.editor Element

    FHIR Specification

    • Short: Who edited the CodeSystem
    • Definition: An individual or organization primarily responsible for internal coherence of the CodeSystem.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reviewer?: ContactDetail[]

    CodeSystem.reviewer Element

    FHIR Specification

    • Short: Who reviewed the CodeSystem
    • Definition: An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the CodeSystem.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endorser?: ContactDetail[]

    CodeSystem.endorser Element

    FHIR Specification

    • Short: Who endorsed the CodeSystem
    • Definition: An individual or organization asserted by the publisher to be responsible for officially endorsing the CodeSystem for use in some setting.
    • Comment: See guidance around (not) making local changes to elements here.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    CodeSystem.relatedArtifact Element

    FHIR Specification

    • Short: Additional documentation, citations, etc
    • Definition: Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.
    • Comment: Each related artifact is either an attachment, or a reference to another resource, but not both.
    • Requirements: A CodeSystem must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    caseSensitive?: BooleanType

    CodeSystem.caseSensitive Element

    FHIR Specification

    • Short: If code comparison is case sensitive
    • Definition: If code comparison is case sensitive when codes within this system are compared to each other.
    • Comment: 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.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    valueSet?: CanonicalType

    CodeSystem.valueSet Element

    FHIR Specification

    • Short: Canonical reference to the value set with entire code system
    • Definition: Canonical reference to the value set that contains all codes in the code system independent of code status.
    • Comment: The definition of the value set SHALL include all codes from this code system, independent of concept status, and only codes from this code system. It SHALL be immutable, and operations SHOULD support validation of any allowed code compositions.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    codesystemHierarchyMeaningEnum: CodesystemHierarchyMeaningEnum

    FHIR CodeSystem: CodesystemHierarchyMeaning

    CodesystemHierarchyMeaningEnum

    hierarchyMeaning?: EnumCodeType

    CodeSystem.hierarchyMeaning Element

    FHIR Specification

    • Short: grouped-by | is-a | part-of | classified-with
    • Definition: The meaning of the hierarchy of concepts as represented in this resource.
    • Comment: Note that other representations might have a different hierarchy or none at all, and represent the information using properties.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: CodesystemHierarchyMeaningEnum

    compositional?: BooleanType

    CodeSystem.compositional Element

    FHIR Specification

    • Short: If code system defines a compositional grammar
    • Definition: The code system defines a compositional (post-coordination) grammar.
    • Comment: Note that the code system resource does not define what the compositional grammar is, only whether or not there is one.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    versionNeeded?: BooleanType

    CodeSystem.versionNeeded Element

    FHIR Specification

    • Short: If definitions are not stable
    • Definition: This flag is used to signify that the code system does not commit to concept permanence across versions. If true, a version must be specified when referencing this code system.
    • Comment: 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'. Most code systems occasionally refine the displays defined for concepts between versions. Contexts in which the concept display values are validated may require that the version be specified for some code systems irrespective of the value of this property.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    codesystemContentModeEnum: CodesystemContentModeEnum

    FHIR CodeSystem: CodesystemContentMode

    CodesystemContentModeEnum

    Privatecontent

    content: null | EnumCodeType

    CodeSystem.content Element

    FHIR Specification

    • Short: not-present | example | fragment | complete | supplement
    • Definition: The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: CodesystemContentModeEnum

    supplements?: CanonicalType

    CodeSystem.supplements Element

    FHIR Specification

    • Short: Canonical URL of Code System this adds designations and properties to
    • Definition: The canonical URL of the code system that this code system supplement is adding designations and properties to.
    • Comment: The most common use of a code system supplement is to add additional language support.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    count?: UnsignedIntType

    CodeSystem.count Element

    FHIR Specification

    • Short: Total concepts in the code system
    • Definition: The total number of concepts defined by the code system. Where the code system has a compositional grammar, the basis of this count is defined by the system steward.
    • Comment: The count of concepts defined in this resource cannot be more than this value but may be less for several reasons - see the content element.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    filter?: CodeSystemFilterComponent[]

    CodeSystem.filter Element

    FHIR Specification

    • Short: Filter that can be used in a value set
    • Definition: A filter that can be used in a value set compose statement when selecting concepts using a filter.
    • Comment: Note that filters defined in code systems usually require custom code on the part of any terminology engine that will make them available for use in value set filters. For this reason, they are generally only seen in high value published terminologies.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    property?: CodeSystemPropertyComponent[]

    CodeSystem.property Element

    FHIR Specification

    • Short: Additional information supplied about each concept
    • Definition: A property defines an additional slot through which additional information can be provided about a concept.
    • Comment: Multiple occurrences of CodeSystem.concept.property may occur for a CodeSystem.property where CodeSystem.concept.property.code is the same and CodeSystem.concept.property.value differs. For example: multiple designations for a single concept.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    concept?: CodeSystemConceptComponent[]

    CodeSystem.concept Element

    FHIR Specification

    • Short: Concepts in the code system
    • Definition: Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meanings of the hierarchical relationships are.
    • Comment: If this is empty, it means that the code system resource does not represent the content of the code system.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided CodeSystem JSON to instantiate the CodeSystem data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR CodeSystem

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CodeSystem

      Returns undefined | CodeSystem

      CodeSystem data model or undefined for CodeSystem

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetVersionAlgorithmsetVersionAlgorithmhasVersionAlgorithmgetVersionAlgorithmStringTypehasVersionAlgorithmStringTypegetVersionAlgorithmCodinghasVersionAlgorithmCodinggetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetCopyrightLabelElementsetCopyrightLabelElementhasCopyrightLabelElementgetCopyrightLabelsetCopyrightLabelhasCopyrightLabelgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetEffectivePeriodsetEffectivePeriodhasEffectivePeriodgetTopicsetTopicaddTopichasTopicgetAuthorsetAuthoraddAuthorhasAuthorgetEditorsetEditoraddEditorhasEditorgetReviewersetRevieweraddReviewerhasReviewergetEndorsersetEndorseraddEndorserhasEndorsergetRelatedArtifactsetRelatedArtifactaddRelatedArtifacthasRelatedArtifactgetCaseSensitiveElementsetCaseSensitiveElementhasCaseSensitiveElementgetCaseSensitivesetCaseSensitivehasCaseSensitivegetValueSetElementsetValueSetElementhasValueSetElementgetValueSetsetValueSethasValueSetgetHierarchyMeaningEnumTypesetHierarchyMeaningEnumTypehasHierarchyMeaningEnumTypegetHierarchyMeaningElementsetHierarchyMeaningElementhasHierarchyMeaningElementgetHierarchyMeaningsetHierarchyMeaninghasHierarchyMeaninggetCompositionalElementsetCompositionalElementhasCompositionalElementgetCompositionalsetCompositionalhasCompositionalgetVersionNeededElementsetVersionNeededElementhasVersionNeededElementgetVersionNeededsetVersionNeededhasVersionNeededgetContentEnumTypesetContentEnumTypehasContentEnumTypegetContentElementsetContentElementhasContentElementgetContentsetContenthasContentgetSupplementsElementsetSupplementsElementhasSupplementsElementgetSupplementssetSupplementshasSupplementsgetCountElementsetCountElementhasCountElementgetCountsetCounthasCountgetFiltersetFilteraddFilterhasFiltergetPropertysetPropertyaddPropertyhasPropertygetConceptsetConceptaddConcepthasConceptfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitContactinitUseContextinitJurisdictioninitTopicinitAuthorinitEditorinitReviewerinitEndorserinitRelatedArtifactinitFilterinitPropertyinitConcept