Class CodeSystem

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class CodeSystem extends MetadataResource
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.
See Also:
  • Field Details Link icon

    • identifier Link icon

      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.
    • purpose Link icon

      protected MarkdownType purpose
      Explanation of why this code system is needed and why it has been designed as it has.
    • caseSensitive Link icon

      If code comparison is case sensitive when codes within this system are compared to each other.
    • valueSet Link icon

      Canonical reference to the value set that contains the entire code system.
    • hierarchyMeaning Link icon

      The meaning of the hierarchy of concepts as represented in this resource.
    • compositional Link icon

      The code system defines a compositional (post-coordination) grammar.
    • versionNeeded Link icon

      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.
    • content Link icon

      The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
    • supplements Link icon

      The canonical URL of the code system that this code system supplement is adding designations and properties to.
    • count Link icon

      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.
    • filter Link icon

      A filter that can be used in a value set compose statement when selecting concepts using a filter.
    • property Link icon

      A property defines an additional slot through which additional information can be provided about a concept.
    • concept Link icon

      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.
    • SP_DATE Link icon

      public static final String SP_DATE
      Search parameter: date

      Description: The code system publication date
      Type: date
      Path: CodeSystem.date

      See Also:
    • DATE Link icon

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: The code system publication date
      Type: date
      Path: CodeSystem.date

    • SP_IDENTIFIER Link icon

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier for the code system
      Type: token
      Path: CodeSystem.identifier

      See Also:
    • IDENTIFIER Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: External identifier for the code system
      Type: token
      Path: CodeSystem.identifier

    • SP_CODE Link icon

      public static final String SP_CODE
      Search parameter: code

      Description: A code defined in the code system
      Type: token
      Path: CodeSystem.concept.code

      See Also:
    • CODE Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: A code defined in the code system
      Type: token
      Path: CodeSystem.concept.code

    • SP_CONTEXT_TYPE_VALUE Link icon

      public static final String SP_CONTEXT_TYPE_VALUE
      Search parameter: context-type-value

      Description: A use context type and value assigned to the code system
      Type: composite
      Path:

      See Also:
    • CONTEXT_TYPE_VALUE Link icon

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
      Fluent Client search parameter constant for context-type-value

      Description: A use context type and value assigned to the code system
      Type: composite
      Path:

    • SP_CONTENT_MODE Link icon

      public static final String SP_CONTENT_MODE
      Search parameter: content-mode

      Description: not-present | example | fragment | complete | supplement
      Type: token
      Path: CodeSystem.content

      See Also:
    • CONTENT_MODE Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTENT_MODE
      Fluent Client search parameter constant for content-mode

      Description: not-present | example | fragment | complete | supplement
      Type: token
      Path: CodeSystem.content

    • SP_JURISDICTION Link icon

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the code system
      Type: token
      Path: CodeSystem.jurisdiction

      See Also:
    • JURISDICTION Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
      Fluent Client search parameter constant for jurisdiction

      Description: Intended jurisdiction for the code system
      Type: token
      Path: CodeSystem.jurisdiction

    • SP_DESCRIPTION Link icon

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the code system
      Type: string
      Path: CodeSystem.description

      See Also:
    • DESCRIPTION Link icon

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: The description of the code system
      Type: string
      Path: CodeSystem.description

    • SP_CONTEXT_TYPE Link icon

      public static final String SP_CONTEXT_TYPE
      Search parameter: context-type

      Description: A type of use context assigned to the code system
      Type: token
      Path: CodeSystem.useContext.code

      See Also:
    • CONTEXT_TYPE Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
      Fluent Client search parameter constant for context-type

      Description: A type of use context assigned to the code system
      Type: token
      Path: CodeSystem.useContext.code

    • SP_LANGUAGE Link icon

      public static final String SP_LANGUAGE
      Search parameter: language

      Description: A language in which a designation is provided
      Type: token
      Path: CodeSystem.concept.designation.language

      See Also:
    • LANGUAGE Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam LANGUAGE
      Fluent Client search parameter constant for language

      Description: A language in which a designation is provided
      Type: token
      Path: CodeSystem.concept.designation.language

    • SP_TITLE Link icon

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the code system
      Type: string
      Path: CodeSystem.title

      See Also:
    • TITLE Link icon

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: The human-friendly name of the code system
      Type: string
      Path: CodeSystem.title

    • SP_VERSION Link icon

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the code system
      Type: token
      Path: CodeSystem.version

      See Also:
    • VERSION Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
      Fluent Client search parameter constant for version

      Description: The business version of the code system
      Type: token
      Path: CodeSystem.version

    • SP_URL Link icon

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the code system
      Type: uri
      Path: CodeSystem.url

      See Also:
    • URL Link icon

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the code system
      Type: uri
      Path: CodeSystem.url

    • SP_CONTEXT_QUANTITY Link icon

      public static final String SP_CONTEXT_QUANTITY
      Search parameter: context-quantity

      Description: A quantity- or range-valued use context assigned to the code system
      Type: quantity
      Path: CodeSystem.useContext.valueQuantity, CodeSystem.useContext.valueRange

      See Also:
    • CONTEXT_QUANTITY Link icon

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
      Fluent Client search parameter constant for context-quantity

      Description: A quantity- or range-valued use context assigned to the code system
      Type: quantity
      Path: CodeSystem.useContext.valueQuantity, CodeSystem.useContext.valueRange

    • SP_SUPPLEMENTS Link icon

      public static final String SP_SUPPLEMENTS
      Search parameter: supplements

      Description: Find code system supplements for the referenced code system
      Type: reference
      Path: CodeSystem.supplements

      See Also:
    • SUPPLEMENTS Link icon

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPLEMENTS
      Fluent Client search parameter constant for supplements

      Description: Find code system supplements for the referenced code system
      Type: reference
      Path: CodeSystem.supplements

    • INCLUDE_SUPPLEMENTS Link icon

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPLEMENTS
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CodeSystem:supplements".
    • SP_SYSTEM Link icon

      public static final String SP_SYSTEM
      Search parameter: system

      Description: The system for any codes defined by this code system (same as 'url')
      Type: uri
      Path: CodeSystem.url

      See Also:
    • SYSTEM Link icon

      public static final ca.uhn.fhir.rest.gclient.UriClientParam SYSTEM
      Fluent Client search parameter constant for system

      Description: The system for any codes defined by this code system (same as 'url')
      Type: uri
      Path: CodeSystem.url

    • SP_NAME Link icon

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the code system
      Type: string
      Path: CodeSystem.name

      See Also:
    • NAME Link icon

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: Computationally friendly name of the code system
      Type: string
      Path: CodeSystem.name

    • SP_CONTEXT Link icon

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the code system
      Type: token
      Path: CodeSystem.useContext.valueCodeableConcept

      See Also:
    • CONTEXT Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: A use context assigned to the code system
      Type: token
      Path: CodeSystem.useContext.valueCodeableConcept

    • SP_PUBLISHER Link icon

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the code system
      Type: string
      Path: CodeSystem.publisher

      See Also:
    • PUBLISHER Link icon

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
      Fluent Client search parameter constant for publisher

      Description: Name of the publisher of the code system
      Type: string
      Path: CodeSystem.publisher

    • SP_CONTEXT_TYPE_QUANTITY Link icon

      public static final String SP_CONTEXT_TYPE_QUANTITY
      Search parameter: context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the code system
      Type: composite
      Path:

      See Also:
    • CONTEXT_TYPE_QUANTITY Link icon

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
      Fluent Client search parameter constant for context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the code system
      Type: composite
      Path:

    • SP_STATUS Link icon

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the code system
      Type: token
      Path: CodeSystem.status

      See Also:
    • STATUS Link icon

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The current status of the code system
      Type: token
      Path: CodeSystem.status

  • Constructor Details Link icon

  • Method Details Link icon