Shareablecodesystem

@POJOBoilerplate
class Shareablecodesystem(val id: Option[String], url: UriStr, val meta: Option[Meta], val text: Option[Narrative], name: String, val date: Option[FHIRDateTime], val title: Option[String], val count: Option[UnsignedInt], val status: PUBLICATION_STATUS, version: String, val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val content: CODESYSTEM_CONTENT_MODE, val language: Option[LANGUAGES], val valueSet: Option[Canonical], val contained: LitSeq[Resource], val extension: LitSeq[Extension], publisher: String, val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val useContext: LitSeq[UsageContext], description: Markdown, val supplements: Option[Canonical], experimental: Boolean, val jurisdiction: LitSeq[CodeableConcept], val implicitRules: Option[UriStr], val caseSensitive: Option[Boolean], val compositional: Option[Boolean], val versionNeeded: Option[Boolean], val hierarchyMeaning: Option[CODESYSTEM_HIERARCHY_MEANING], val modifierExtension: LitSeq[Extension], val filter: LitSeq[Filter], val property: LitSeq[Property], concept: NonEmptyLitSeq[Concept], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends CodeSystem

Enforces the minimum information set for the value set metadata required by HL7 and other organizations that share and publish value sets

Subclass of hl7.model.CodeSystem (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.)

Value parameters:
caseSensitive
  • If code comparison is case sensitive when codes within this system are compared to each other.
compositional
  • The code system defines a compositional (post-coordination) grammar.
concept
  • 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.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • 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.
content
  • The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.
copyright
  • 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.
count
  • 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.
date
  • The date (and optionally time) when the code system was published. 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.
description
  • A free text natural language description of the code system from a consumer's perspective.
experimental
  • 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.
extension
  • May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
filter
  • A filter that can be used in a value set compose statement when selecting concepts using a filter.
hierarchyMeaning
  • The meaning of the hierarchy of concepts as represented in this resource.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
implicitRules
  • A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
jurisdiction
  • A legal or geographic region in which the code system is intended to be used.
language
  • The base language in which the resource is written.
meta
  • The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
modifierExtension
  • 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
name
  • 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.
property
  • A property defines an additional slot through which additional information can be provided about a concept.
publisher
  • The name of the organization or individual that published the code system.
purpose
  • Explanation of why this code system is needed and why it has been designed as it has.
status
  • The date (and optionally time) when the code system resource was created or revised.
supplements
  • The canonical URL of the code system that this code system supplement is adding designations and properties to.
text
  • A human-readable narrative that contains a summary of the resource and can 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.
title
  • A short, descriptive, user-friendly title for the code system.
url
  • 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 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.
useContext
  • 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.
valueSet
  • Canonical reference to the value set that contains the entire code system.
version
  • 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.
versionNeeded
  • 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.
Constructor:

Inherits all params from parent. Requires the following fields which were optional in the parent: url, name, version, publisher, description, experimental, concept.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): Shareablecodesystem

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Shareablecodesystem]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: Shareablecodesystem <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: Shareablecodesystem <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): Shareablecodesystem

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: Shareablecodesystem <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: Shareablecodesystem <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): Shareablecodesystem
Inherited from:
FHIRObject
def withField[T : LTag, Up >: Shareablecodesystem <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: Shareablecodesystem <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: Shareablecodesystem <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): Shareablecodesystem
Inherited from:
FHIRObject

Concrete fields

override val caseSensitive: Option[Boolean]
override val compositional: Option[Boolean]
override val contact: LitSeq[ContactDetail]
override val contained: LitSeq[Resource]
override val count: Option[UnsignedInt]
override val date: Option[FHIRDateTime]
override val extension: LitSeq[Extension]
override val filter: LitSeq[Filter]
override val id: Option[String]
override val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
override val jurisdiction: LitSeq[CodeableConcept]
override val language: Option[LANGUAGES]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
override val property: LitSeq[Property]
override val purpose: Option[Markdown]
override val supplements: Option[Canonical]
override val text: Option[Narrative]
override val thisTypeName: String
override val title: Option[String]
override val useContext: LitSeq[UsageContext]
override val valueSet: Option[Canonical]
override val versionNeeded: Option[Boolean]

Inherited fields

val companion: CompanionFor[Shareablecodesystem]
Inherited from:
FHIRObject